Get payment request by ID (Partner API)

Server URLloading...

GET

/partner_api/payment_requests/{id}

Send

Authorization

Path

Retrieves a payment request by its ID. Returns the same structure as the create endpoint but includes the current status.

When the payment is still pending, the response may include a Retry-After header (seconds) advising clients when to poll again:

• Pre-checkout (no provider session yet, e.g. redirect before the payer opens the pay link): fixed shorter interval (default 60s).
• Post-checkout (pending provider request exists): PSP reconcile interval (default 5 minutes, may count down until the next check).

Authentication:

• Requires API key headers X-API-KEY and X-API-KEY-ID

Access Control:

• Only returns payment requests that belong to the authenticated business
• Only returns payment requests created via the Partner API

Path Parameters

Response Body

curl -X GET "https://example.com/partner_api/payment_requests/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "string",  "storeId": "string",  "reference": "string",  "type": "redirect",  "paymentMethod": "orange",  "status": "pending",  "errorReason": "string",  "transaction": {    "id": "string",    "amount": {      "amount": 0,      "currency": "XOF"    },    "fees": {      "amount": 0,      "currency": "XOF"    },    "status": "pending",    "counterpartLabel": "string",    "counterpartIdentifier": "string",    "description": "string",    "executedAt": "string"  }}