Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
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"
}