Skip to main content
API docs by Redocly

Pay at Counter REST API (1)

Download OpenAPI specification:Download

Documentation for the yetipay Pay at Counter REST API (v1).

Terminals

List Terminals

Retrieves a list of all currently connected card terminals. Results can be filtered by currency, capabilities, and status.

Authorizations:
connectBasicAuth
query Parameters
capabilities
string

Restricts the response to terminals that have specific capabilities. Values should be provided as a comma-separated list.

currency
string
Enum: "GBP" "EUR"

Restricts the response to terminals configured for a specific currency.

status
string
Enum: "AVAILABLE" "BUSY"

Restricts the response to show only available or only busy terminals.

Responses

Response Schema: application/connect.v1+json
Array of objects (Terminal)
Array
capabilities
Array of strings
currency
string
Enum: "GBP" "EUR"
location
string
status
string
Enum: "AVAILABLE" "BUSY"
tpi
string

Response samples

Content type
application/connect.v1+json
{
  • "terminals": [
    ]
}

Get Terminal by ID

Retrieves details for a specific terminal.

Authorizations:
connectBasicAuth
path Parameters
tpi
required
string

Unique identifier of the terminal to use in this request.

Responses

Response Schema: application/connect.v1+json
capabilities
Array of strings
currency
string
Enum: "GBP" "EUR"
location
string
status
string
Enum: "AVAILABLE" "BUSY"
tpi
string

Response samples

Content type
application/connect.v1+json
{
  • "tpi": "12345678",
  • "status": "AVAILABLE",
  • "currency": "GBP",
  • "capabilities": [
    ],
  • "location": ""
}

Transactions

Start Transaction

Initiates a transaction on the terminal identified by the given terminal identifier.

Authorizations:
connectBasicAuth
path Parameters
tpi
required
string

Unique identifier of the terminal to use in this request.

Request Body schema: application/connect.v1+json
required
transactionType
required
string
Enum: "SALE" "REFUND" "DUPLICATE"

Type of the transaction.

amount
integer

Base amount for the transaction (in pence).

currency
string
Enum: "GBP" "EUR"

Currency for the request. Uses the textual representation from ISO 4217.

Responses

Response Schema: application/connect.v1+json
location
string
requestId
string <uuid>

Request samples

Content type
application/connect.v1+json
{
  • "transactionType": "SALE",
  • "amount": 1234,
  • "currency": "GBP"
}

Response samples

Content type
application/connect.v1+json
{
  • "requestId": "d19912ad-11a3-4af3-86e0-d6eb2ebea63c",
  • "location": ""
}

Get Transaction Status

Retrieves data for the transaction identified by the given requestId.

Authorizations:
connectBasicAuth
path Parameters
requestId
required
string

Request Id (a UUID assigned to a terminal request) for the terminal request to use in this request.

tpi
required
string

Unique identifier of the terminal to use in this request.

Responses

Response Schema: application/connect.v1+json
amountBase
string
amountCashback
string
amountGratuity
string
amountTotal
string
applicationId
string
applicationLabel
string
authCode
string
cardHolderVerificationMethod
string
cardSchemeName
string
currency
string
Enum: "GBP" "EUR"
dateOfExpiry
string
dateOfStart
string
location
string
notifications
Array of strings
paymentMethod
string
primaryAccountNumber
string
primaryAccountNumberSequence
string
object
requestId
string <uuid>
transactionId
string
transactionNumber
string
transactionResult
string
transactionTime
string
transactionType
string
Enum: "SALE" "REFUND" "DUPLICATE"

Response samples

Content type
application/connect.v1+json
{
  • "amountBase": "100",
  • "amountCashback": "30",
  • "amountGratuity": "20",
  • "amountTotal": "150",
  • "applicationId": "A0000000031010",
  • "applicationLabel": "VISA",
  • "authCode": "78YT6RS0",
  • "cardSchemeName": "VISA",
  • "cardHolderVerificationMethod": "PIN",
  • "currency": "GBP",
  • "dateOfExpiry": "01/25",
  • "dateOfStart": "01/19",
  • "location": "",
  • "notifications": [
    ],
  • "paymentMethod": "ICC_CHIP",
  • "primaryAccountNumber": "************1234",
  • "primaryAccountNumberSequence": "01",
  • "receiptLines": {
    },
  • "requestId": "d19912ad-11a3-4af3-86e0-d6eb2ebea63c",
  • "transactionId": "1234567",
  • "transactionNumber": "0012",
  • "transactionResult": "SUCCESSFUL",
  • "transactionTime": "2019-03-04T16:12:00",
  • "transactionType": "SALE"
}

Cancel Transaction

Attempts to cancel the transaction identified by the given requestId.

Authorizations:
connectBasicAuth
path Parameters
requestId
required
string

Request Id (a UUID assigned to a terminal request) for the terminal request to use in this request.

tpi
required
string

Unique identifier of the terminal to use in this request.

Responses

Reports

Request Report

Initiates a report on the terminal identified by the given terminal identifier.

Authorizations:
connectBasicAuth
path Parameters
tpi
required
string

Unique identifier of the terminal to use in this request.

Request Body schema: application/connect.v1+json
required
reportType
required
string
Enum: "END_OF_DAY" "BANKING" "X_BALANCE" "Z_BALANCE"

Type of the report.

Responses

Response Schema: application/connect.v1+json
location
string
requestId
string <uuid>

Request samples

Content type
application/connect.v1+json
{
  • "reportType": "END_OF_DAY"
}

Response samples

Content type
application/connect.v1+json
{
  • "requestId": "d19912ad-11a3-4af3-86e0-d6eb2ebea63c",
  • "location": ""
}

Retrieve Report

Retrieves data for the report identified by the given requestId.

Authorizations:
connectBasicAuth
path Parameters
requestId
required
string

Request Id (a UUID assigned to a terminal request) for the terminal request to use in this request.

tpi
required
string

Unique identifier of the terminal to use in this request.

Responses

Response Schema: application/connect.v1+json
object
object
location
string
notifications
Array of strings
Array of objects (ReceiptLine)
reportResult
string
reportTime
string
reportType
string
Enum: "END_OF_DAY" "BANKING" "X_BALANCE" "Z_BALANCE"
requestId
string <uuid>
tpi
string

Response samples

Content type
application/connect.v1+json
{
  • "balances": {
    },
  • "banking": {
    },
  • "reportLines": [
    ],
  • "reportTime": "2019-03-04T16:12:00",
  • "reportType": "END_OF_DAY",
  • "reportResult": "COMPLETE",
  • "tpi": "string",
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "location": "string",
  • "notifications": [
    ]
}