Pay at Counter REST API (v1)

Download OpenAPI specification:Download

Introduction

Documentation for the yetipay Pay at Counter REST API.

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

status	string Enum: "AVAILABLE" "BUSY" Restricts the response to show only available or only busy terminals.
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.

Responses

Response samples

200

Content type

application/connect.v1+json

{"terminals": [{"tpi": "12345678",
"status": "AVAILABLE",
"currency": "GBP",
"capabilities": ["SALE",
"REFUND"
],
"location": "https://connect.yeti.host/pac/terminals/{tpi}"
}
]
}

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 samples

200

Content type

application/connect.v1+json

{"tpi": "12345678",
"status": "AVAILABLE",
"currency": "GBP",
"capabilities": ["SALE",
"REFUND"
],
"location": "https://connect.yeti.host/pac/terminals/{tpi}"
}

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	string (transactionType) Enum: "SALE" "REFUND" "DUPLICATE" Type of the transaction.
amount	integer Base amount for the transaction (in pence).
currency	string (currency) Enum: "GBP" "EUR" Currency for the request. Uses the textual representation from ISO 4217.

Responses

Request samples

Payload

Content type

application/connect.v1+json

{"transactionType": "SALE",
"amount": 1234,
"currency": "GBP"
}

Response samples

201

Content type

application/connect.v1+json

{"requestId": "d19912ad-11a3-4af3-86e0-d6eb2ebea63c",
"location": "https://connect.yeti.host/pac/terminals/{tpi}/{requestType}/{requestId}"
}

Get Transaction Status

Retrieves data for the transaction identified by the given requestId.

Authorizations:

connectBasicAuth

path Parameters

tpi required	string Unique identifier of the terminal to use in this request.
requestId required	string Request Id (a UUID assigned to a terminal request) for the terminal request to use in this request.

Responses

Response samples

200

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": "https://connect.yeti.host/pac/terminals/{tpi}/transactions/{requestId}",
"notifications": ["TRANSACTION_FINISHED",
"APPROVED",
"CONNECTION_MADE",
"CONNECTING",
"PIN_ENTRY",
"PLEASE_WAIT",
"PRESENT_CARD",
"TRANSACTION_STARTED"
],
"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"
}

Cancel Transaction

Attempts to cancel the transaction identified by the given requestId.

Authorizations:

connectBasicAuth

path Parameters

tpi required	string Unique identifier of the terminal to use in this request.
requestId required	string Request Id (a UUID assigned to a terminal request) for the terminal request to use in this request.

Responses

Response samples

204

Content type

application/connect.v1+json

null

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

string (reportType)

Enum: "END_OF_DAY" "BANKING" "X_BALANCE" "Z_BALANCE"

Type of the report.

Responses

Request samples

Payload

Content type

application/connect.v1+json

{"reportType": "END_OF_DAY"
}

Response samples

201

Content type

application/connect.v1+json

{"requestId": "d19912ad-11a3-4af3-86e0-d6eb2ebea63c",
"location": "https://connect.yeti.host/pac/terminals/{tpi}/{requestType}/{requestId}"
}

Retrieve Report

Retrieves data for the report identified by the given requestId.

Authorizations:

connectBasicAuth

path Parameters

tpi required	string Unique identifier of the terminal to use in this request.
requestId required	string Request Id (a UUID assigned to a terminal request) for the terminal request to use in this request.

Responses

Response samples

200

Content type

application/connect.v1+json

{"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",
"tpi": "12345678",
"requestId": "d19912ad-11a3-4af3-86e0-d6eb2ebea63c",
"location": "https://connect.yeti.host/pac/terminals/{tpi}/report/{requestId}",
"notifications": [["REPORT_FINISHED",
"REPORT_STARTED"
]
]
}

Pay at Counter REST API (v1)

Introduction

Terminals

List Terminals

Authorizations:

query Parameters

Responses

Response samples

Get Terminal by ID

Authorizations:

path Parameters

Responses

Response samples

Transactions

Start Transaction

Authorizations:

path Parameters

Request Body schema: application/connect.v1+jsonrequired

Responses

Request samples

Response samples

Get Transaction Status

Authorizations:

path Parameters

Responses

Response samples

Cancel Transaction

Authorizations:

path Parameters

Responses

Response samples

Reports

Request Report

Authorizations:

path Parameters

Request Body schema: application/connect.v1+jsonrequired

Responses

Request samples

Response samples

Retrieve Report

Authorizations:

path Parameters

Responses

Response samples

Request Body schema: application/connect.v1+json
required

Request Body schema: application/connect.v1+json
required