Tables Payment Device Simulator (1.0)

Download OpenAPI specification:Download

Authentication

ApiKeyAuth

Security Scheme Type	API Key
Header parameter name:	accountName

GetBillItems

A request from Connect for bill items:

Receive a GetBillItems request from Connect
If the specified session does not exist, the EPOS should send an Error response with the code SESSION_NO_SUCH_SESSION
Otherwise, if the session exists but no bill exists, return an Error response with the code BILL_NO_SUCH_BILL
Otherwise, if the session and the bill exists, the EPOS should send a GetBillItems response

Authorizations:

ApiKeyAuth

Request Body schema: application/json

sessionId required	string <uuid> (sessionId) ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a... The ID of the session to get bill items for
required	CardMachineRequest (object) or ConsumerDeviceRequest (object) An object providing information on the requesting device or service

Responses

Request samples

Payload

Content type

application/json

Example

{"sessionId": "01234567-0123-0123-0123-0123456789ab",
"requestorInfo": {"requestorType": "REQUESTOR_TYPE_CARD_MACHINE",
"cardMachineRequestorInfo": {"terminalId": "12345678",
"waiterId": 1234
}
}
}

Response samples

200
default

Content type

application/json

{"totalAmount": 950,
"paidAmount": 100,
"taxAmount": 190,
"currency": "GBP",
"items": [{"id": "123456789",
"name": "Classic Burger",
"category": ["mains",
"burgers"
],
"quantity": 1,
"amountPerItem": 1000,
"lastOrderedAt": "2021-01-01T15:00:00Z",
"modifiers": [{"id": "mod-987654321",
"name": "Extra Cheddar Cheese",
"amountPerModifier": 100,
"quantity": 3
}
]
},
{"id": "987654321",
"name": "Peroni",
"category": ["drinks",
"beer",
"lager"
],
"quantity": 1,
"amountPerItem": 450,
"lastOrderedAt": "2021-01-01T15:00:00Z"
},
{"id": "987654321",
"name": "Peroni",
"category": ["drinks",
"beer",
"lager"
],
"quantity": 1,
"amountPerItem": 0,
"lastOrderedAt": "2021-01-01T15:00:00Z",
"modifiers": [{"id": "mod-123123",
"name": "Buy 1 get 1 free!",
"amountPerModifier": -450,
"quantity": 1
}
]
},
{"id": "00000001",
"name": "£5 Voucher",
"category": ["discounts",
"vouchers"
],
"quantity": 1,
"amountPerItem": -500,
"lastOrderedAt": "2021-01-01T15:00:00Z"
}
],
"sessionId": "123e4567-e89b-12d3-a456-426614174000"
}

GetFullBill

A request from Connect for an itemised bill receipt:

Receive a GetFullBill request from Connect
If the specified session does not exist, the EPOS should send an Error response with the code SESSION_NO_SUCH_SESSION
Otherwise, if the session exists but no bill exists, return an Error response with the code BILL_NO_SUCH_BILL
Otherwise, if the session and the bill exists, the EPOS should respond with a GetFullBill response

;

Authorizations:

ApiKeyAuth

Request Body schema: application/json

sessionId required	string <uuid> (sessionId) ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a... The ID of the session to get bill items for
required	CardMachineRequest (object) or ConsumerDeviceRequest (object) An object providing information on the requesting device or service

Responses

Request samples

Payload

Content type

application/json

Example

{"sessionId": "01234567-0123-0123-0123-0123456789ab",
"requestorInfo": {"requestorType": "REQUESTOR_TYPE_CARD_MACHINE",
"cardMachineRequestorInfo": {"terminalId": "12345678",
"waiterId": 1234
}
}
}

Response samples

200
default

Content type

application/json

{"header": {"receiptLines": [{"receiptLineType": "RECEIPT_LINE_TYPE_LOGO",
"receiptLogo": {"svgImage": "<path d=\\\"M127.230822,29.0095321 L127.230822,44.8571699 L127.228945,44.857 L127.226632,45.0782852 C127.101225,49.363888 124.174005,52.9391141 120.231189,53.999935 L120.230818,49.0517119 C121.686353,48.2013585 122.665635,46.6119543 122.665635,44.7915457 L122.665595,29.0095321 L127.230822,29.0095321 Z M98.8846365,22 L98.8846365,38.4687967 C98.8846365,43.6902675 94.6571667,47.923106 89.4423183,47.923106 C84.2274699,47.923106 80,43.6902675 80,38.4687967 C80,33.2473259 84.2274699,29.0144875 89.4423183,29.0144875 C91.2255567,29.0144875 92.8933384,29.5094441 94.3161065,30.3696359 L94.3157729,22 L98.8846365,22 Z M150.711618,43.6154088 C151.890535,43.6154088 152.846235,44.5711098 152.846235,45.7500266 C152.846235,46.9289435 151.890535,47.8846444 150.711618,47.8846444 C149.532701,47.8846444 148.577,46.9289435 148.577,45.7500266 C148.577,44.5711098 149.532701,43.6154088 150.711618,43.6154088 Z M139.134682,29.0000078 C144.34953,29.0000078 148.577,33.2274777 148.577,38.4423261 C148.577,43.6571745 144.34953,47.8846444 139.134682,47.8846444 C133.919833,47.8846444 129.692363,43.6571745 129.692363,38.4423261 C129.692363,33.2274777 133.919833,29.0000078 139.134682,29.0000078 Z M110.788496,29.0000078 C116.003344,29.0000078 120.230814,33.2274777 120.230814,38.4423261 C120.230814,43.6571745 116.003344,47.8846444 110.788496,47.8846444 C105.573648,47.8846444 101.346178,43.6571745 101.346178,38.4423261 C101.346178,33.2274777 105.573648,29.0000078 110.788496,29.0000078 Z M150.711618,44.1490633 C149.82743,44.1490633 149.110654,44.865839 149.110654,45.7500266 C149.110654,46.6342142 149.82743,47.3509899 150.711618,47.3509899 C151.595805,47.3509899 152.312581,46.6342142 152.312581,45.7500266 C152.312581,44.865839 151.595805,44.1490633 150.711618,44.1490633 Z M150.787549,44.7437068 L150.916706,44.7499643 C151.081083,44.7666509 151.214137,44.8167107 151.315867,44.9001438 C151.443029,45.0044351 151.50661,45.1526386 151.50661,45.3447542 C151.50661,45.4783203 151.474591,45.5903877 151.410553,45.6809565 C151.346514,45.7715253 151.25686,45.8369361 151.141591,45.8771888 L151.141591,45.8771888 L151.539544,46.5770385 L151.54572,46.5928195 L151.54572,46.5928195 L151.547778,46.6072281 C151.547778,46.6236952 151.541832,46.6374177 151.529939,46.6483958 C151.518046,46.6593738 151.504781,46.6648628 151.490143,46.6648628 L151.490143,46.6648628 L151.237649,46.6648628 L151.198539,46.6597169 L151.198539,46.6597169 L151.169036,46.644279 C151.152569,46.6305564 151.137931,46.6127171 151.125124,46.5907611 L151.125124,46.5907611 L150.773827,45.9403125 L150.397829,45.9403125 L150.397829,46.5989946 L150.393026,46.6243813 L150.393026,46.6243813 L150.378617,46.6456512 C150.36581,46.658459 150.349343,46.6648628 150.329216,46.6648628 L150.329216,46.6648628 L150.076721,46.6648628 L150.051335,46.6600599 L150.051335,46.6600599 L150.030065,46.6456512 C150.017257,46.6328435 150.010853,46.6172913 150.010853,46.5989946 L150.010853,46.5989946 L150.010853,44.8123195 L150.015313,44.7848744 L150.015313,44.7848744 L150.028692,44.7629184 C150.040585,44.7501107 150.056595,44.7437068 150.076721,44.7437068 L150.076721,44.7437068 L150.787549,44.7437068 Z M150.779316,45.0510918 L150.397829,45.0510918 L150.397829,45.6274386 L150.779316,45.6274386 C150.889096,45.6274386 150.971431,45.6031954 151.026321,45.5547091 C151.081212,45.5062228 151.108657,45.435323 151.108657,45.3420097 C151.108657,45.2486964 151.081212,45.1768817 151.026321,45.1265658 C150.971431,45.0762498 150.889096,45.0510918 150.779316,45.0510918 L150.779316,45.0510918 Z M89.4423183,33.5891533 C86.7507836,33.5891533 84.5688637,35.7738441 84.5688637,38.4687967 C84.5688637,41.1637494 86.7507836,43.3484402 89.4423183,43.3484402 C92.1338529,43.3484402 94.3157729,41.1637494 94.3157729,38.4687967 C94.3157729,35.7738441 92.1338529,33.5891533 89.4423183,33.5891533 Z M139.134682,33.5688715 C136.443147,33.5688715 134.261227,35.7507915 134.261227,38.4423261 C134.261227,41.1338608 136.443147,43.3157807 139.134682,43.3157807 C141.826216,43.3157807 144.008136,41.1338608 144.008136,38.4423261 C144.008136,35.7507915 141.826216,33.5688715 139.134682,33.5688715 Z M110.788496,33.5688715 C108.096961,33.5688715 105.915041,35.7507915 105.915041,38.4423261 C105.915041,41.1338608 108.096961,43.3157807 110.788496,43.3157807 C113.480031,43.3157807 115.661951,41.1338608 115.661951,38.4423261 C115.661951,35.7507915 113.480031,33.5688715 110.788496,33.5688715 Z M124.948209,22 C126.208861,22 127.230822,23.0233504 127.230822,24.285717 C127.230822,25.5480836 126.208861,26.571434 124.948209,26.571434 C123.687556,26.571434 122.665595,25.5480836 122.665595,24.285717 C122.665595,23.0233504 123.687556,22 124.948209,22 Z\\\" id=\\\"Combined-Shape-Copy-87\\\"></path>"
}
},
{"receiptLineType": "RECEIPT_LINE_TYPE_MERCHANT_NAME",
"receiptMerchantName": {"merchantName": "Bob's Shop"
}
},
{"receiptLineType": "RECEIPT_LINE_TYPE_MERCHANT_PHONE_NUMBER",
"receiptMerchantPhoneNumber": {"phoneNumber": "01234 567890"
}
},
{"receiptLineType": "RECEIPT_LINE_TYPE_MERCHANT_EMAIL_ADDRESS",
"receiptMerchantEmailAddress": {"emailAddress": "info@bobsshop.com"
}
},
{"receiptLineType": "RECEIPT_LINE_TYPE_MERCHANT_ADDRESS",
"receiptMerchantAddress": {"addressLines": ["1",
"High Street",
"London"
],
"postcode": "ABC 123"
}
},
{"receiptLineType": "RECEIPT_LINE_TYPE_TEXT",
"receiptText": {"value": "Here is your bill",
"size": "SIZE_HEADER_2",
"align": "ALIGN_CENTER"
}
},
{"receiptLineType": "RECEIPT_LINE_TYPE_HORIZONTAL_LINE",
"receiptHorizontalLine": {"type": "HORIZONTAL_LINE_SINGLE"
}
}
]
},
"billItems": {"totalAmount": 950,
"paidAmount": 100,
"taxAmount": 190,
"currency": "GBP",
"items": [{"id": "123456789",
"name": "Classic Burger",
"category": ["mains",
"burgers"
],
"quantity": 1,
"amountPerItem": 1000,
"lastOrderedAt": "2021-01-01T15:00:00.123+02:00",
"modifiers": [{"id": "mod-987654321",
"name": "Extra Cheddar Cheese",
"amountPerModifier": 100,
"quantity": 3
}
]
},
{"id": "987654321",
"name": "Peroni",
"category": ["drinks",
"beer",
"lager"
],
"quantity": 1,
"amountPerItem": 450,
"lastOrderedAt": "2021-01-01T15:00:00.123+02:00"
},
{"id": "987654321",
"name": "Peroni",
"category": ["drinks",
"beer",
"lager"
],
"quantity": 1,
"amountPerItem": 0,
"lastOrderedAt": "2021-01-01T15:00:00.123+02:00",
"modifiers": [{"id": "mod-123123",
"name": "Buy 1 get 1 free!",
"amountPerModifier": -450,
"quantity": 1
}
]
},
{"id": "00000001",
"name": "£5 Voucher",
"category": ["discounts",
"vouchers"
],
"quantity": 1,
"amountPerItem": -500,
"lastOrderedAt": "2021-01-01T15:00:00.123+02:00"
}
],
"sessionId": "123e4567-e89b-12d3-a456-426614174000"
},
"footer": {"receiptLines": [{"receiptLineType": "RECEIPT_LINE_TYPE_HORIZONTAL_LINE",
"receiptHorizontalLine": {"type": "HORIZONTAL_LINE_DOUBLE"
}
},
{"receiptLineType": "RECEIPT_LINE_TYPE_TEXT",
"receiptText": {"value": "Thanks for dining with us!",
"size": "SIZE_BODY",
"align": "ALIGN_CENTER"
}
},
{"receiptLineType": "RECEIPT_LINE_TYPE_TEXT",
"receiptText": {"value": "Scan below to enter a survey",
"size": "SIZE_BODY",
"align": "ALIGN_CENTER"
}
},
{"receiptLineType": "RECEIPT_LINE_TYPE_URL",
"receiptURL": {"description": "Voucher code!",
"showQR": true,
"url": "https://bobs-shop.com/voucher-link"
}
},
{"receiptLineType": "RECEIPT_LINE_TYPE_VAT_NUMBER",
"receiptVATNumber": {"vatNumber": "123456789"
}
}
]
}
}

GetSession

A request from Connect for a session. If the session does not exist, return SESSION_NO_SUCH_SESSION error message, otherwise return a session object.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

sessionId required	string <uuid> (sessionId) ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a... The ID of the session to get bill items for
required	CardMachineRequest (object) or ConsumerDeviceRequest (object) An object providing information on the requesting device or service

Responses

Request samples

Payload

Content type

application/json

Example

{"sessionId": "01234567-0123-0123-0123-0123456789ab",
"requestorInfo": {"requestorType": "REQUESTOR_TYPE_CARD_MACHINE",
"cardMachineRequestorInfo": {"terminalId": "12345678",
"waiterId": 1234
}
}
}

Response samples

200
default

Content type

application/json

Example

{"id": "123e4567-e89b-12d3-a456-426614174001",
"name": "Bob's party",
"tableName": "Table 102",
"createdAt": "2021-01-01T15:00:00.000Z",
"isPayable": true,
"numberOfCovers": 15,
"waiter": {"id": 1234,
"name": "John Smith"
}
}

GetTable

A request from Connect for a table. If the table doesn't exist, the EPOS should return a SESSION_NO_SUCH_SESSION error message

Authorizations:

ApiKeyAuth

Request Body schema: application/json

name required	string (name) A human readable, EPOS-level unique table name. The table name MUST NOT include this sequence of characters: ' - ' (whitespace hyphen whitespace)
required	CardMachineRequest (object) or ConsumerDeviceRequest (object) An object providing information on the requesting device or service

Responses

Request samples

Payload

Content type

application/json

Example

{"name": "Table 101",
"requestorInfo": {"requestorType": "REQUESTOR_TYPE_CARD_MACHINE",
"cardMachineRequestorInfo": {"terminalId": "12345678",
"waiterId": 1234
}
}
}

Response samples

200
default

Content type

application/json

{"name": "Tables 101",
"maxCovers": 2,
"status": "TABLE_STATUS_AVAILABLE"
}

ListBillItems

A request from Connect for multiple bills. The EPOS should return a list of the bills for sessions specified. If no bills can be found, or the specified sessions don't exist, the EPOS should return an empty list. Omitting sessionIds returns all bills:

Receive a ListBillItems request from Connect
The EPOS should respond with a ListBillItems response

Authorizations:

ApiKeyAuth

Request Body schema: application/json

sessionIds	Array of strings <uuid> (sessionIds) The ID of the session to get
required	CardMachineRequest (object) or ConsumerDeviceRequest (object) An object providing information on the requesting device or service

Responses

Request samples

Payload

Content type

application/json

Example

{"requestorInfo": {"requestorType": "REQUESTOR_TYPE_CARD_MACHINE",
"cardMachineRequestorInfo": {"terminalId": "12345678",
"waiterId": 1234
}
}
}

Response samples

200
default

Content type

application/json

[{"totalAmount": 950,
"paidAmount": 100,
"taxAmount": 190,
"currency": "GBP",
"items": [{"id": "123456789",
"name": "Classic Burger",
"category": ["mains",
"burgers"
],
"quantity": 1,
"amountPerItem": 1000,
"lastOrderedAt": "2021-01-01T15:00:00Z",
"modifiers": [{"id": "mod-987654321",
"name": "Extra Cheddar Cheese",
"amountPerModifier": 100,
"quantity": 3
}
]
},
{"id": "987654321",
"name": "Peroni",
"category": ["drinks",
"beer",
"lager"
],
"quantity": 1,
"amountPerItem": 450,
"lastOrderedAt": "2021-01-01T15:00:00Z"
},
{"id": "987654321",
"name": "Peroni",
"category": ["drinks",
"beer",
"lager"
],
"quantity": 1,
"amountPerItem": 0,
"lastOrderedAt": "2021-01-01T15:00:00Z",
"modifiers": [{"id": "mod-123123",
"name": "Buy 1 get 1 free!",
"amountPerModifier": -450,
"quantity": 1
}
]
},
{"id": "00000001",
"name": "£5 Voucher",
"category": ["discounts",
"vouchers"
],
"quantity": 1,
"amountPerItem": -500,
"lastOrderedAt": "2021-01-01T15:00:00Z"
}
],
"sessionId": "123e4567-e89b-12d3-a456-426614174000"
}
]

ListSessions

A request from Connect for a list of sessions. If there are filtering params specified, the response from the EPOS should contain only sessions matching all of the filters. If no sessions match the filters, the EPOS should return an empty list.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

hasTable	boolean (hasTable) If set and true, the returned list of sessions should only be for sessions that have a table. If false, only for sessions without a table
isFinished	boolean (isFinished) If set and true, the returned list of sessions should only be for sessions that are finished. If false, only for sessions that are not finished
isPayable	boolean (isPayable) If set and true, the returned list of sessions should only be for sessions that can currently be paid
tableNames	Array of strings (tableNames) If not empty, the returned list of sessions MUST only contain sessions linked to the tables with tableName from this list. If empty, this field MUST be ignored
required	CardMachineRequest (object) or ConsumerDeviceRequest (object) An object providing information on the requesting device or service

Responses

Request samples

Payload

Content type

application/json

Example

{"hasTable": true,
"isFinished": false,
"isPayable": true,
"requestorInfo": {"requestorType": "REQUESTOR_TYPE_CARD_MACHINE",
"cardMachineRequestorInfo": {"terminalId": "12345678",
"waiterId": 1234
}
}
}

Response samples

200
default

Content type

application/json

[{"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Andrew's party",
"tableName": "Table 101",
"createdAt": "2021-01-01T15:00:00.000Z",
"isPayable": false,
"numberOfCovers": 15,
"finishedAt": "2021-01-01T17:00:00.000Z",
"waiter": {"id": 1234,
"name": "John Smith"
}
},
{"id": "123e4567-e89b-12d3-a456-426614174001",
"name": "Bob's party",
"tableName": "Table 102",
"createdAt": "2021-01-01T15:00:00.000Z",
"isPayable": true,
"numberOfCovers": 15,
"waiter": {"id": 1234,
"name": "John Smith"
}
}
]

ListTables

A request for a list of tables. If there are params set, the response should contain only tables matching all of the filters using AND logic

Authorizations:

ApiKeyAuth

Request Body schema: application/json

statuses	Array of strings (statuses) Items Enum: "TABLE_STATUS_UNSPECIFIED" "TABLE_STATUS_AVAILABLE" "TABLE_STATUS_PENDING_AVAILABLE" "TABLE_STATUS_OCCUPIED" "TABLE_STATUS_NOT_IN_USE" If set, the returned list of tables should only be for ones that have matching statuses using OR logic
required	CardMachineRequest (object) or ConsumerDeviceRequest (object) An object providing information on the requesting device or service

Responses

Request samples

Payload

Content type

application/json

Example

{"requestorInfo": {"requestorType": "REQUESTOR_TYPE_CARD_MACHINE",
"cardMachineRequestorInfo": {"terminalId": "12345678",
"waiterId": 1234
}
}
}

Response samples

200
default

Content type

application/json

[{"name": "Tables 101",
"maxCovers": 2,
"status": "TABLE_STATUS_AVAILABLE"
},
{"name": "Tables 102",
"maxCovers": 5,
"status": "TABLE_STATUS_AVAILABLE"
},
{"name": "Tables 103",
"maxCovers": 2,
"status": "TABLE_STATUS_OCCUPIED"
}
]

LockSession

A request from Connect to lock a specific session. If the session does not exist, the EPOS should return SESSION_NO_SUCH_SESSION error. If it is already locked, the EPOS should return SESSION_ALREADY_LOCKED error. Otherwise, the EPOS should return a bill for the session.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

sessionId required	string <uuid> (sessionId) ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a... The ID of the session to get bill items for
required	CardMachineRequest (object) or ConsumerDeviceRequest (object) An object providing information on the requesting device or service

Responses

Request samples

Payload

Content type

application/json

Example

{"sessionId": "01234567-0123-0123-0123-0123456789ab",
"requestorInfo": {"requestorType": "REQUESTOR_TYPE_CARD_MACHINE",
"cardMachineRequestorInfo": {"terminalId": "12345678",
"waiterId": 1234
}
}
}

Response samples

200
default

Content type

application/json

{"totalAmount": 950,
"paidAmount": 100,
"taxAmount": 190,
"currency": "GBP",
"items": [{"id": "123456789",
"name": "Classic Burger",
"category": ["mains",
"burgers"
],
"quantity": 1,
"amountPerItem": 1000,
"lastOrderedAt": "2021-01-01T15:00:00Z",
"modifiers": [{"id": "mod-987654321",
"name": "Extra Cheddar Cheese",
"amountPerModifier": 100,
"quantity": 3
}
]
},
{"id": "987654321",
"name": "Peroni",
"category": ["drinks",
"beer",
"lager"
],
"quantity": 1,
"amountPerItem": 450,
"lastOrderedAt": "2021-01-01T15:00:00Z"
},
{"id": "987654321",
"name": "Peroni",
"category": ["drinks",
"beer",
"lager"
],
"quantity": 1,
"amountPerItem": 0,
"lastOrderedAt": "2021-01-01T15:00:00Z",
"modifiers": [{"id": "mod-123123",
"name": "Buy 1 get 1 free!",
"amountPerModifier": -450,
"quantity": 1
}
]
},
{"id": "00000001",
"name": "£5 Voucher",
"category": ["discounts",
"vouchers"
],
"quantity": 1,
"amountPerItem": -500,
"lastOrderedAt": "2021-01-01T15:00:00Z"
}
],
"sessionId": "123e4567-e89b-12d3-a456-426614174000"
}

RecordPayment

A request from Connect to record a payment. If the session does not exist, the EPOS should return a SESSION_NO_SUCH_SESSION error. If the session connected to the payment is not locked, the EPOS should return a SESSION_NOT_LOCKED error. If this particular payment has already been recorded, the EPOS should return a PAYMENT_ALREADY_RECORDED error. If the EPOS cannot record the payment for internal reasons, return a PAYMENT_NOT_RECORDED error. If the request is successful, the EPOS should return a RecordPayment response.

Receive a RecordPayment request from Connect
If the specified session does not exist, the EPOS should respond with an Error response with the code SESSION_NO_SUCH_SESSION
Otherwise, if the specified session exists and is not locked, the EPOS should respond with an Error response with the code SESSION_NOT_LOCKED
Otherwise, if the session exists AND is locked AND the session has already been recorded, the EPOS should respond with an Error response with the code PAYMENT_ALREADY_RECORDED
Otherwise, if the session exists AND is locked AND is yet to be recorded AND fails to record on the EPOS, the EPOS should respond with an Error response with the code PAYMENT_NOT_RECORDED
Otherwise, if the session exists AND is locked AND has not already been recorded AND is successfully recorded on the EPOS, the EPOS should respond with a RecordPayment response

Authorizations:

ApiKeyAuth

Request Body schema: application/json

required	object (Payment) An object representing a single payment
required	CardMachineRequest (object) or ConsumerDeviceRequest (object) An object providing information on the requesting device or service

Responses

Request samples

Payload

Content type

application/json

Example

{"requestorInfo": {"requestorType": "REQUESTOR_TYPE_CARD_MACHINE",
"cardMachineRequestorInfo": {"terminalId": "12345678",
"waiterId": 1234
}
},
"payment": {"id": "01234567-0123-0123-0123-0123456789ab",
"sessionId": "01234567-0123-0123-0123-0123456789af",
"currency": "GBP",
"baseAmount": 100,
"gratuityAmount": 200,
"cashbackAmount": 300,
"paymentSuccessful": true,
"methodDetails": {"method": "PAYMENT_METHOD_CARD_PRESENT",
"cardPresentPaymentInfo": {"authCode": "ABC123",
"entryMode": "ENTRY_MODE_CONTACTLESS",
"card": {"scheme": "CARD_SCHEME_AMEX",
"last4PAN": "1234",
"expiryDate": {"month": 12,
"year": 2032
},
"fundingType": "CARD_FUNDING_TYPE_CREDIT"
},
"cardholderVerificationMethod": "CARDHOLDER_VERIFICATION_METHOD_PIN",
"terminalId": "12345678",
"merchantId": "12341234",
"acquirerTransactionId": "01234567-0123-0123-0123-0123456789ab"
},
"cardPresentPaymentStatus": "CARD_PRESENT_PAYMENT_STATUS_SUCCESSFUL"
},
"attemptedAt": "2021-01-01T15:00:00.000Z"
}
}

Response samples

200
default

Content type

application/json

{ }

UnlockSession

A request from Connect to unlock a locked session. If the session is not locked, the EPOS should return SESSION_NOT_LOCKED error. If the EPOS cannot unlock the session due to internal reasons, it should return a SESSION_UNABLE_TO_UNLOCK error. Otherwise, the EPOS should return an empty result

Authorizations:

ApiKeyAuth

Request Body schema: application/json

sessionId required	string <uuid> (sessionId) ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a... The ID of the session to get bill items for
required	CardMachineRequest (object) or ConsumerDeviceRequest (object) An object providing information on the requesting device or service

Responses

Request samples

Payload

Content type

application/json

Example

{"sessionId": "01234567-0123-0123-0123-0123456789ab",
"requestorInfo": {"requestorType": "REQUESTOR_TYPE_CARD_MACHINE",
"cardMachineRequestorInfo": {"terminalId": "12345678",
"waiterId": 1234
}
}
}

Response samples

200
default

Content type

application/json

{ }