Pay at Counter REST API (v2)
Download OpenAPI specification:Download
List Terminals
Retrieves a list of all currently connected card terminals. Results can be filtered by currency and status.
Authorizations:
query Parameters
| status | string Enum: "AVAILABLE" "BUSY" Restricts the response to show only available or only busy terminals. |
| currency | string Enum: "GBP" "EUR" Restricts the response to terminals configured for a specific currency. |
Responses
Response samples
- 200
- 401
- 422
{- "terminals": [
- {
- "tid": "12345678",
- "status": "AVAILABLE",
- "currency": "GBP",
}
]
}Get Terminal by ID
Retrieves details for a specific terminal.
Authorizations:
path Parameters
| tid required | string Unique identifier of the terminal to use. |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "tid": "12345678",
- "status": "AVAILABLE",
- "currency": "GBP",
}Start Transaction
Initiates a transaction on the terminal identified by the given terminal identifier.
Authorizations:
path Parameters
| tid required | string Unique identifier of the terminal to use. |
Request Body schema: application/connect.v2+jsonrequired
| transactionType | string (transactionType) Enum: "SALE" "REFUND" "DUPLICATE" "PRE_AUTH" "COMPLETION" "ACCOUNT_VERIFICATION" Type of the transaction. |
| currency | string (currency) Enum: "GBP" "EUR" Currency for the request. Uses the textual representation from ISO 4217. |
| amount | integer [ 1 .. 99999999 ] Accepted for all transactions except duplicates. Base amount for the transaction (in pence). |
| amountCashback | integer [ 0 .. 10000 ] Only accepted for sale transactions. Amount of cashback to attempt to include in this transaction (in pence). The amountCashback field in the transaction should always be checked to determine the actual amount of cashback processed. |
| cardholderNotPresent | boolean Accepted for all transactions except duplicates. Indicates whether this transaction should be completed as CNP (e.g. manual entry of card details). If set, the PDQ will skip the present card screen (for sales and refunds) and immediately prompt for manual entry of card details. Transactions with this flag set are permitted to take longer to complete than a standard transaction. |
| authCode | string Required for completion transactions and not accepted for any other transaction types. Should contain the authorization code of the first pre-auth transaction performed on a customer's card. Pre-auths and completions must be completed on the same card. |
| amountPreAuthorisedTotal | integer [ 1 .. 99999999 ] Required for completion transactions and not accepted for any other transaction types. Should contain the sum of all pre-auth transactions performed on a customer's card. Pre-auths and completions must be processed on the same card. |
Responses
Request samples
- Payload
{- "transactionType": "SALE",
- "amount": 100,
- "amountCashback": 50,
- "currency": "GBP",
- "cardholderNotPresent": true
}Response samples
- 201
- 401
- 404
- 422
{- "requestId": "d19912ad-11a3-4af3-86e0-d6eb2ebea63c",
}Get Transaction Status
Retrieves data for the transaction identified by the given requestId.
Authorizations:
path Parameters
| tid required | string Unique identifier of the terminal to use. |
| requestId required | string Id (a UUID assigned to a terminal request) for the request to use. |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "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",
- "notifications": [
- "TRANSACTION_FINISHED",
- "APPROVED",
- "CONNECTION_MADE",
- "CONNECTING",
- "PIN_ENTRY",
- "PLEASE_WAIT",
- "PRESENT_CARD",
- "TRANSACTION_STARTED",
- "REPLACE_PAPER"
], - "paymentMethod": "ICC_CHIP",
- "primaryAccountNumber": "************1234",
- "primaryAccountNumberSequence": "01",
- "receiptLines": {
- "MERCHANT": [
- {
- "format": [
- "BOLD"
], - "type": "TEXT",
- "value": "John's Shop"
}
], - "CUSTOMER": [
- {
- "format": [
- "BOLD"
], - "type": "TEXT",
- "value": "John's Shop"
}
]
}, - "requestId": "d19912ad-11a3-4af3-86e0-d6eb2ebea63c",
- "transactionId": "1234567",
- "transactionNumber": "0012",
- "transactionResult": "SUCCESSFUL",
- "transactionTime": "2019-03-04T16:12:00",
- "transactionType": "SALE",
- "userMessage": "Signature check not actioned before timeout. When required, signatures must be verified within 80 seconds."
}Cancel Transaction
Attempts to cancel the transaction identified by the given requestId.
Authorizations:
path Parameters
| tid required | string Unique identifier of the terminal to use. |
| requestId required | string Id (a UUID assigned to a terminal request) for the request to use. |
Responses
Response samples
- 401
- 404
- 422
{- "userMessage": "This is an example error message. The string here should be displayed to the user."
}Request Report
Initiates a report on the terminal identified by the given terminal identifier.
Authorizations:
path Parameters
| tid required | string Unique identifier of the terminal to use. |
Request Body schema: application/connect.v2+jsonrequired
| reportType | string (reportType) Enum: "END_OF_DAY" "BANKING" "X_BALANCE" "Z_BALANCE" The type of report. |
Responses
Request samples
- Payload
{- "reportType": "END_OF_DAY"
}Response samples
- 201
- 401
- 422
{- "requestId": "d19912ad-11a3-4af3-86e0-d6eb2ebea63c",
}Retrieve Report
Retrieves data for the report identified by the given requestId.
Authorizations:
path Parameters
| tid required | string Unique identifier of the terminal to use. |
| requestId required | string Id (a UUID assigned to a terminal request) for the request to use. |
Responses
Response samples
- 200
- 401
- 404
- 422
{- "balances": {
- "currency": "GBP",
- "issuerTotals": {
- "{issuerName}": {
- "currency": "GBP",
- "totalAmount": 0,
- "totalRefundsAmount": 0,
- "totalRefundsCount": 0,
- "totalSalesAmount": 0,
- "totalSalesCount": 0
}
}, - "totalAmount": "1000",
- "totalCashbackAmount": "100",
- "totalCashbackCount": "2",
- "totalGratuityAmount": "100",
- "totalGratuityCount": "3",
- "totalRefundsAmount": "400",
- "totalRefundsCount": "9",
- "totalSalesAmount": "1200",
- "totalSalesCount": "14",
- "totalsSince": "INSTALLATION",
- "waiterTotals": {
- "{waiterId}": {
- "currency": "GBP",
- "totalAmount": 0,
- "totalRefundsAmount": 0,
- "totalRefundsCount": 0,
- "totalSalesAmount": 0,
- "totalSalesCount": 0
}
}
}, - "banking": {
- "{acquirerName}": {
- "currency": "GBP",
- "currentSessionIssuerTotals": {
- "{issuerName}": {
- "currency": "GBP",
- "totalAmount": 0,
- "totalRefundsAmount": 0,
- "totalRefundsCount": 0,
- "totalSalesAmount": 0,
- "totalSalesCount": 0
}
}, - "previousSessionIssuerTotals": {
- "{issuerName}": {
- "currency": "GBP",
- "totalAmount": 0,
- "totalRefundsAmount": 0,
- "totalRefundsCount": 0,
- "totalSalesAmount": 0,
- "totalSalesCount": 0
}
}, - "currentSessionTotals": {
- "currency": "GBP",
- "totalAmount": 0,
- "totalRefundsAmount": 0,
- "totalRefundsCount": 0,
- "totalSalesAmount": 0,
- "totalSalesCount": 0
}, - "previousSessionTotals": {
- "currency": "GBP",
- "totalAmount": 0,
- "totalRefundsAmount": 0,
- "totalRefundsCount": 0,
- "totalSalesAmount": 0,
- "totalSalesCount": 0
}, - "currentSessionTransactionNumbers": [
- "0076",
- "0123"
], - "previousSessionTransactionNumbers": [
- "0000",
- "0075"
]
}
}, - "reportLines": [
- {
- "format": [
- "BOLD"
], - "type": "TEXT",
- "value": "John's Shop"
}
], - "reportTime": "2019-03-04T16:12:00",
- "reportType": "END_OF_DAY",
- "reportResult": "COMPLETE",
- "tid": "12345678",
- "requestId": "d19912ad-11a3-4af3-86e0-d6eb2ebea63c",
- "notifications": [
- [
- "REPORT_FINISHED",
- "REPORT_STARTED"
]
]
}