BAbanqzinc
Payments

Check payment status (public, keyed by provider request id). Returns a minimal, PII-free status view used by the embedded checkout page.

Changed on

Check payment status (public, keyed by provider request id). Returns a minimal, PII-free status view used by the embedded checkout page.

get/api/v1/payments/{paymentRequestId}/status

Request

Path parameters

paymentRequestIdstring required

The paymentRequestId parameter

Response

Success

statusstring required

Current payment status (e.g. pending, completed, failed, cancelled)

amountstring required

Payment amount in minor units

currencystring required

The currency of the payment

order_idstring nullable

The merchant's order identifier, if one was provided

Example response

{
  "status": "pending",
  "amount": "1000",
  "currency": "GBP",
  "order_id": "1140"
}

Changes

  • b372e7d5563dRevision changes
    • breaking

      the / response's property type changed from string to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added subschema #1 subschema #2 to the / response property allOf list for the response status

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 6637b341d86dRevision changes
    • info

      endpoint added