Sign in

v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB
Order and Pay

Apply a Payment

Add a payment to an existing order.

post/o/op/1/pay

Request body

iKaccountIdinteger
iKaccountIdentifierstring

The ID of the account to apply this payment to.

thirdPartyPaymentReferencestring required

A unique external reference provided for this order. This value will be sent back in the webhook.

endpointIdstring required

Endpoint ID for a unique webhook that has been created using the webhook endpoint.

businessLocationIdinteger required

The unique identifier for the business location.

taskTtlInMsinteger

Maximum time to attempt delivery of this payment to the POS. In milliseconds. The minimum value is 60000ms (1 minute).

staffIdinteger

The ID of the employee responsible for this payment.

deviceIdinteger

POS device to specifically receive this payment. If left null then all POS devices may receive the payment but only one will process it.

paymentMethodstring

Payment method code as configured by the merchant.

paymentAmountnumber required

The total amount of the payment without tips.

tipAmountnumber

The tip amount, if any.

targetPrinterProfileIdinteger

The printer profile id to use for printing the receipt for this payment. If not provided, the default active printer profile for the business location will be used.

Example request

{
  "iKaccountIdentifier": "A1234.56",
  "thirdPartyPaymentReference": "12345678901234",
  "endpointId": "MY-AWESOME-ENDPOINT-ID",
  "businessLocationId": 45454565682155,
  "taskTtlInMs": 60000,
  "deviceId": 12345678980,
  "paymentMethod": "OOPAYMENT",
  "paymentAmount": 20.06,
  "tipAmount": 2.5,
  "targetPrinterProfileId": 1773881235
}

Response

accepted

statusstring

The response.

Example response

{
  "status": "ok"
}