Payment Notification

POST https://webhook.example.com

What your webhook implementation will receive when placing a payment

application/json

Body Required

reason string

Reason for failure if applicable.
thirdPartyReference string

Third-party reference you provided when the order or payment was placed.
businessLocationId integer(int64)

The unique identifier for the business location.
ikentooAccountIdentifier string

The K-series account identifier for a SUCCESS event (V3 format)
iKentooAccountId integer(int64) Deprecated

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

Status of the order or payment operation.

Values are SUCCESS or FAILURE.
errors object

Error details when status is FAILURE.
Hide errors attributes Show errors attributes object
- timeout object
  
  Timeout error details.
  Hide timeout attributes Show timeout attributes object
  
  errorKey string
  
  message string
- account object
  
  Account error details.
  Hide account attribute Show account attribute object
  
  type string
  
  Values are ACCOUNT_NOT_FOUND, ACCOUNT_ALREADY_CLOSED, INVALID_TASK, ITEM_NOT_ADDED, ITEM_NOT_FOUND, MISSING_STAFF, NATIVE_PAYMENT_NOT_SUPPORTED, OVERPAID, PAYMENT_ID_NOT_FOUND, PAYMENT_METHOD_NOT_FOUND, STAFF_NOT_FOUND, UPDATE_FAILED, or UNKNOWN.
type string

Notification type

Default value is PAYMENT.

Responses

200

Your server returns this code if it accepts the callback

POST apePayment notification

Request examples

{
  "thirdPartyReference": "REF11",
  "businessLocationId": 247158188015618,
  "status": "SUCCESS",
  "ikentooAccountId": "2114502594134196",
  "ikentooAccountIdentifier": "A123080.14",
  "type": "PAYMENT"
}

{
  "reason": "the payment amount is greater than the amount due",
  "thirdPartyReference": "REF12212",
  "businessLocationId": 141948669832802,
  "status": "FAILURE",
  "ikentooAccountIdentifier": "A78094.73",
  "type": "PAYMENT"
}

{
  "reason": "Account not found",
  "thirdPartyReference": "REF12213",
  "businessLocationId": 141948669832802,
  "status": "FAILURE",
  "errors": {
    "account": {
      "type": "ACCOUNT_NOT_FOUND"
    }
  },
  "type": "PAYMENT"
}