Sign in
Payments

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

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

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

Changed in 3 of the 8 revisions of this API.319

  • b372e7d5563d218See the full diff
    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

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

      response-property-all-of-added

    • ○

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

      response-property-any-of-added

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6637b341d86d1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog