v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB

Order and Pay

Payment Notification

What your webhook implementation will receive when placing a payment

postWebhookapePayment notification

Payload

reasonstring

Reason for failure if applicable.

thirdPartyReferencestring

Third-party reference you provided when the order or payment was placed.

businessLocationIdinteger

The unique identifier for the business location.

ikentooAccountIdentifierstring

The K-series account identifier for a SUCCESS event (V3 format)

iKentooAccountIdinteger

The K-series account identifier for a SUCCESS event (V2 format)

status'SUCCESS' | 'FAILURE'

Status of the order or payment operation.

typestring

Notification type

Example payload

{
  "businessLocationId": 45454565682155,
  "errors": {
    "timeout": {
      "errorKey": "errors.payment.pos.task_timeout",
      "message": "Not processed before validity ended"
    },
    "account": {
      "type": "ACCOUNT_NOT_FOUND"
    }
  }
}

Response

Your server returns this code if it accepts the callback