{ "info": { "_postman_id": "402df49e-a518-4390-a679-2b41fc8cadfa", "name": "HyperPay Payment COPYandPAY API", "description": "HyperPay is a MENA / Saudi Arabia payment gateway built on the ACI / OPPWA Open Payment Platform. This REST API powers the COPYandPAY hosted widget and the Server-to-Server integration, supporting card brands (VISA, MASTER, AMEX), the Saudi domestic scheme mada, STC Pay, and Apple Pay. All requests are sent as application/x-www-form-urlencoded over TLS, authenticated with an `entityId` (channel identifier) plus an `Authorization: Bearer` access token. Amounts are decimal strings and currency is an ISO 4217 code (SAR for Saudi merchants).\n\nContact Support:\n Name: HyperPay Support\n Email: info@hyperpay.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:57:11.000Z", "updatedAt": "2026-07-28T01:57:11.000Z", "lastUpdatedBy": "35240", "uid": "35240-402df49e-a518-4390-a679-2b41fc8cadfa" }, "item": [ { "name": "v1", "item": [ { "name": "checkouts", "item": [ { "name": "{id}", "item": [ { "name": "payment", "item": [ { "name": "Get payment status of a checkout", "id": "4a49b815-b3fe-4481-b499-6c49a8fd7c12", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/checkouts/:id/payment?entityId=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "checkouts", ":id", "payment" ], "query": [ { "description": "(Required) The channel (entity) identifier.", "key": "entityId", "value": "" } ], "variable": [ { "id": "39149d6c-49e0-4e82-bf48-fd3d3bb06832", "key": "id", "value": "", "description": "(Required) The checkout id returned by POST /v1/checkouts." } ] }, "description": "Retrieves the result of a checkout after the shopper submits the COPYandPAY widget. Pass the entityId as a query parameter and the Bearer token in the Authorization header." }, "response": [ { "id": "b9112725-cef2-426a-8f02-7240e733f10b", "name": "Payment result.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/checkouts/:id/payment?entityId=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "checkouts", ":id", "payment" ], "query": [ { "description": "(Required) The channel (entity) identifier.", "key": "entityId", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"paymentType\": \"\",\n \"paymentBrand\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"result\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"card\": {\n \"bin\": \"\",\n \"last4Digits\": \"\",\n \"holder\": \"\",\n \"expiryMonth\": \"\",\n \"expiryYear\": \"\"\n },\n \"registrationId\": \"\",\n \"merchantTransactionId\": \"\",\n \"timestamp\": \"\",\n \"ndc\": \"\"\n}", "createdAt": "2026-07-28T01:57:11.000Z", "updatedAt": "2026-07-28T01:57:11.000Z", "uid": "35240-b9112725-cef2-426a-8f02-7240e733f10b" } ], "createdAt": "2026-07-28T01:57:11.000Z", "updatedAt": "2026-07-28T01:57:11.000Z", "uid": "35240-4a49b815-b3fe-4481-b499-6c49a8fd7c12" } ], "id": "30c9b4b2-19ed-47f9-9c04-7b1e966d054f", "createdAt": "2026-07-28T01:57:11.000Z", "updatedAt": "2026-07-28T01:57:11.000Z", "uid": "35240-30c9b4b2-19ed-47f9-9c04-7b1e966d054f" } ], "id": "59992a57-4498-4cdb-a7bf-9b62bde44a63", "createdAt": "2026-07-28T01:57:11.000Z", "updatedAt": "2026-07-28T01:57:11.000Z", "uid": "35240-59992a57-4498-4cdb-a7bf-9b62bde44a63" }, { "name": "Prepare a checkout", "id": "82234588-d1b5-491a-8442-d58d953bf4f8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Channel (entity) identifier.", "key": "entityId", "value": "" }, { "description": "(Required) Decimal amount as a string with two decimals.", "key": "amount", "value": "" }, { "description": "(Required) ISO 4217 currency code.", "key": "currency", "value": "" }, { "description": "(Required) DB = debit, PA = pre-authorization.", "key": "paymentType", "value": "PA" }, { "key": "merchantTransactionId", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/checkouts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "checkouts" ] }, "description": "Creates a checkout and returns a checkout `id` used to initialize the COPYandPAY JavaScript widget in the shopper's browser. Send entityId, amount, currency and paymentType (e.g. DB for debit, PA for pre-authorization)." }, "response": [ { "id": "09024baf-b005-41d1-9d6c-c6a71087f96c", "name": "Checkout prepared.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Channel (entity) identifier.", "key": "entityId", "value": "" }, { "description": "(Required) Decimal amount as a string with two decimals.", "key": "amount", "value": "" }, { "description": "(Required) ISO 4217 currency code.", "key": "currency", "value": "" }, { "description": "(Required) DB = debit, PA = pre-authorization.", "key": "paymentType", "value": "PA" }, { "key": "merchantTransactionId", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/v1/checkouts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "checkouts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"result\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"buildNumber\": \"\",\n \"timestamp\": \"\",\n \"ndc\": \"\"\n}", "createdAt": "2026-07-28T01:57:11.000Z", "updatedAt": "2026-07-28T01:57:11.000Z", "uid": "35240-09024baf-b005-41d1-9d6c-c6a71087f96c" } ], "createdAt": "2026-07-28T01:57:11.000Z", "updatedAt": "2026-07-28T01:57:11.000Z", "uid": "35240-82234588-d1b5-491a-8442-d58d953bf4f8" } ], "id": "405b8f31-1e90-4529-8895-715158017c9f", "createdAt": "2026-07-28T01:57:11.000Z", "updatedAt": "2026-07-28T01:57:11.000Z", "uid": "35240-405b8f31-1e90-4529-8895-715158017c9f" } ], "id": "3cc48de9-167c-4696-92fe-6566fb41e178", "createdAt": "2026-07-28T01:57:11.000Z", "updatedAt": "2026-07-28T01:57:11.000Z", "uid": "35240-3cc48de9-167c-4696-92fe-6566fb41e178" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://eu-prod.oppwa.com" } ] }