gets the latest payment request status

get/payment_requests/{id}

Request

  • Base URL
    //api.cryptoqr.net/scanner/v1 (relative, and the document’s source URL is not known)
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

Payment request ID provided during /scan POST request (e.g. paymentRequestID-6c54-4b01-90e6-d701748f0851)

Response

payment request status has been successfully retrieved

idstring

A unique ID that we assign to the payment request.

created_atstring date-time

ISO8601 timestamp at which the payment request was created

amount_centsinteger

The amount of the payment request in the currency base unit (e.g. cents or sats)

currencystring

The currency of the payment request that the receiver expects to receive

status'REQUESTED' | 'AUTHORIZED' | 'CONFIRMED' | 'EXPIRED' | 'CANCELLED' | 'ERRORED'

The current status of the payment request

payment_methodsobject

list of payment method types with payment instruction data the client can use to complete payment

expiry_timestring

ISO8601 timestamp at which the payment request will expire

merchant_namestring

Merchant name

merchant_codestring

Merchant code

merchant_category_codestring

Merchant category code

order_descriptionstring

Optional merchant provided order description

notification_urlunknown
merchant_infoobject

Additional merchant information, structure depends on specific merchant.

Example response

{
  "id": "paymentRequest-6c54-4b01-90e6-d701748f0851",
  "created_at": "2023-03-08T13:37:00Z",
  "amount_cents": 100,
  "currency": "ZAR",
  "payment_methods": {
    "lightning": "lnbc901..."
  },
  "expiry_time": "2023-03-08T13:37:00Z",
  "merchant_name": "Pick n Pay",
  "merchant_code": "pnp",
  "order_description": "Groceries"
}

Changes

No recorded changes to this operation across all 1 revision of this API.