Skip to main content

Get payment status

Fetches payment status by payment_details_id.

Using Checkout Builder​

After you send a payment request from the Checkout Builder, use the returned payment_details_id with:

GET /payments/status?version=2024-10-01&api_key=<your_api_key>&payment_details_id=<payment_details_id>

Endpoint​

GET /payments/status

Query Parameters​

  • version (string, required) - API contract version. Use exactly 2024-10-01.
  • api_key (string, required)
  • payment_details_id (string, required)

Header Parameters​

  • PW-subscription-key (string, required)
  • PW-origin-country (string, required)
  • PW-request-date (string, required) - UTC request timestamp formatted as YYYY-MM-DD HH:mm:ss.
  • PW-ip-address (string, required)
  • User-Agent (string, required)

Header Constraints​

KeyDescriptionExampleData typeRequirementField Length
PW-subscription-keyDeveloper key available after portal registration. Production key is shared on request.eed0d85c530c4b26a91d09b783d8fab3stringmandatory32
PW-origin-countryISO Alpha-2 country code where the transaction is created.TTstringmandatory2
PW-request-dateCurrent request timestamp. Format: YYYY-MM-DD HH:mm:ss (UTC).2014-10-08 16:01:31stringmandatory19
PW-ip-addressFixed institution IP used for PayWise network-level validation.255.255.255.255stringconditional8-16
User-AgentIn programmable environments, this avoids running into Cloudflare issues.Mozilla/5.0 (Windows NT 10.0; Win64; x64)stringmandatory255

Request Body​

No JSON request body.

Responses​

200 - Wrapper-normalized response envelope (success cases).​

Schema provided without concrete example payload.

Notes​

This endpoint page is generated from openapi/pw-wrappers.2024-10-01.yaml.