{ "info": { "_postman_id": "71813fbf-af7c-496e-967e-b5efce34da42", "name": "Atlas Online — Merchant API v2.20", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Atlas Online Merchant API — contract version 2.20 (contract date 2026-11-04).\n\nEvery response carries `X-Api-Version: 2026-11-04`.\n\nAll requests are authenticated with a per-request HMAC-SHA256 signature over the canonical string `.` (body is empty for `GET`; for `multipart/form-data` it is the whole encoded multipart body as sent, boundaries and file bytes included, signed as raw bytes). The signature is sent as a lowercase hex string in the `X-Signature` header.\n\nThe **collection-level pre-request script** computes and injects all three headers automatically on every request. Set the `apiKey` and `apiSecret` collection variables before sending requests.\n\nSee https://api.atlas-online.io/docs for the rendered reference.\n\n\nContact Support:\n Name: Atlas Online", "type": "text/plain" } }, "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "X-Api-Key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Atlas Online — auto-sign every request with HMAC-SHA256.", "// Set `apiKey` and `apiSecret` in the collection variables (or in an environment).", "const apiKey = pm.variables.get('apiKey');", "const apiSecret = pm.variables.get('apiSecret');", "if (!apiKey || !apiSecret) {", " console.warn('[Atlas] Missing apiKey or apiSecret. Open Collection > Variables and fill them in.');", " return;", "}", "", "const method = pm.request.method.toUpperCase();", "const reqBody = pm.request.body;", "", "// Canonical body: empty for GET, the raw text for JSON, and for multipart the", "// whole encoded form, boundary included. Postman picks its own boundary at send", "// time, so text-only forms are encoded here with a fixed boundary and sent raw.", "// The HMAC runs over the bytes sent: crypto-js hashes the string as UTF-8, the", "// same bytes Postman puts on the wire for these raw bodies.", "let body = '';", "if (method !== 'GET' && reqBody) {", " if (reqBody.mode === 'raw' && reqBody.raw) {", " // Resolve {{var}} placeholders inside the body before signing.", " body = pm.variables.replaceIn(reqBody.raw);", " } else if (reqBody.mode === 'formdata') {", " const parts = reqBody.formdata.all().filter(f => !f.disabled);", " if (parts.some(f => f.type === 'file')) {", " console.warn('[Atlas] File fields cannot be signed from Postman. Send files from '", " + 'your own client: see \"Sign a multipart request\" in the docs.');", " } else {", " const boundary = 'AtlasPostman' + Date.now();", " body = parts.map(f => '--' + boundary + '\\r\\n'", " + 'Content-Disposition: form-data; name=\"' + f.key + '\"\\r\\n\\r\\n'", " + pm.variables.replaceIn(f.value || '') + '\\r\\n').join('')", " + '--' + boundary + '--\\r\\n';", " pm.request.body.update({ mode: 'raw', raw: body });", " pm.request.headers.upsert({", " key: 'Content-Type', value: 'multipart/form-data; boundary=' + boundary });", " }", " }", "}", "", "const timestamp = Math.floor(Date.now() / 1000).toString();", "const canonical = timestamp + '.' + body;", "const cryptoJs = require('crypto-js');", "const signature = cryptoJs.HmacSHA256(canonical, apiSecret).toString(cryptoJs.enc.Hex);", "", "pm.request.headers.upsert({ key: 'X-Api-Key', value: apiKey });", "pm.request.headers.upsert({ key: 'X-Timestamp', value: timestamp });", "pm.request.headers.upsert({ key: 'X-Signature', value: signature });" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://api.atlas-online.io" }, { "key": "apiKey", "value": "", "type": "string", "description": "mk_<48-hex>" }, { "key": "apiSecret", "value": "", "type": "string", "description": "64-hex secret. Treat as password." } ], "item": [ { "name": "api", "description": "", "item": [ { "name": "merchant", "description": "", "item": [ { "name": "pay-in", "description": "", "item": [ { "id": "7e354710-d15e-4342-8271-e1cd6a65c4a2", "name": "Create PayIn (Argentina)", "request": { "name": "Create PayIn (Argentina)", "description": { "content": "Reserves a banking destination for an inbound payment and returns the\nrecipient details that the merchant presents to the customer.\nIdempotent on `merchantOrderId`.\n\nv2.0: `clientReference` is REQUIRED. `paymentMethod` is optional.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 5000.00,\n \"currency\": \"ARS\",\n \"geo\": 1,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-12345\",\n \"clientReference\": \"customer-7781\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "6590ade2-b403-4262-975c-eaeb28f92dc4", "name": "PayIn created.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 5000.00,\n \"currency\": \"ARS\",\n \"geo\": 1,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-12345\",\n \"clientReference\": \"customer-7781\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "2026-10-06" } ], "body": "{\n \"payInId\": \"\",\n \"displayId\": \"\",\n \"geo\": \"Argentina\",\n \"ownerName\": \"\",\n \"bankName\": \"\",\n \"amount\": \"\",\n \"currency\": \"ARS\",\n \"expiresAt\": \"\",\n \"requiresManualConfirmation\": \"\",\n \"cbu\": \"\",\n \"qrImageBase64\": \"\",\n \"qrPayload\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41089955-0885-4374-9bfa-f0b9f13f5c32", "name": "Validation or business-rule failure.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 5000.00,\n \"currency\": \"ARS\",\n \"geo\": 1,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-12345\",\n \"clientReference\": \"customer-7781\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "385b2ade-2be0-4003-9a9e-704f9175b326", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 5000.00,\n \"currency\": \"ARS\",\n \"geo\": 1,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-12345\",\n \"clientReference\": \"customer-7781\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e354710-d15e-4342-8271-e1cd6a65c4a3", "name": "Create PayIn (Venezuela)", "request": { "name": "Create PayIn (Venezuela)", "description": { "content": "Reserves a banking destination for an inbound payment — Venezuela geo.\n\nv2.0: `clientReference` is REQUIRED. `paymentMethod` is optional (ven_bank / ven_bank_account).\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 1500.00,\n \"currency\": \"VES\",\n \"geo\": 2,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-ve-12345\",\n \"clientReference\": \"customer-7781\",\n \"paymentMethod\": \"ven_bank\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create PayIn (SouthKorea)", "request": { "name": "Create PayIn (SouthKorea)", "description": { "content": "Reserves a payment destination for an inbound payment — South Korea geo (v2.3).\n\n`paymentMethod` is REQUIRED for SouthKorea (`kor_bank` | `kakao_pay`). Amount must be a whole number of KRW.\nThe 201 response carries `accountNumber` + `bankName` + `ownerName` for kor_bank, or `qrPayload` (+ `qrImageBase64`) for kakao_pay.\nNo UTR — the trader confirms against the payer's bank/Kakao receipt (`requiresManualConfirmation` is always true).\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 50000,\n \"currency\": \"KRW\",\n \"geo\": 4,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-kr-12345\",\n \"clientReference\": \"customer-7781\",\n \"paymentMethod\": \"kor_bank\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create PayIn (India)", "request": { "name": "Create PayIn (India)", "description": { "content": "Reserves a payment destination for an inbound payment — India geo (v2.2, `upi_intent` added in v2.6).\n\n`paymentMethod` is REQUIRED for India (`upi` | `upi_intent` | `imps`). Amount must be a whole number of INR.\nThe 201 response carries `upiVpa` (+ `qrPayload`/`qrImageBase64`) for the UPI rail, or `accountNumber` + `ifscCode` for imps.\nSince v2.6 every India pay-in on the UPI rail (`upi` AND `upi_intent`) also returns `upiIntentLink` — the `upi://pay?pa=…&pn=…&am=…&cu=INR` deep link. The key is omitted for imps, for non-India geos and for cascade-routed orders.\nAfter the payer transfers, relay their UTR via POST /pay-in/{payInId}/utr — it is mandatory evidence for confirming an India pay-in.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 5000,\n \"currency\": \"INR\",\n \"geo\": 3,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-in-12345\",\n \"clientReference\": \"customer-7781\",\n \"paymentMethod\": \"upi\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create PayIn (India, UPI Intent)", "request": { "name": "Create PayIn (India, UPI Intent)", "description": { "content": "Reserves a payment destination for an inbound payment on the India UPI rail using the `upi_intent` method (v2.6).\n\n`upi_intent` (\"UPI Intent\", rail `upi`) is the intent-oriented variant of `upi`: routing, spreads, the UTR confirmation flow and every webhook are IDENTICAL — `upi` and `upi_intent` are one rail, so the order is served by any active UPI-rail card and traders keep no separate requisites. The only difference is how you hand the payer the requisites.\n\nThe 201 response is byte-identical in shape to a plain `upi` response and carries `upiIntentLink` — `upi://pay?pa=&pn=&am=&cu=INR`. On Android render it as a tap target (\"Pay in UPI app\"): the payer's UPI app opens pre-filled with the VPA, payee name and exact amount. Keep the QR (`qrImageBase64` / `upiVpa`) as the iOS/desktop fallback. The payer still submits a UTR via POST /pay-in/{payInId}/utr exactly as for `upi`.\n\nDeploy prerequisite: the `upi_intent` method must exist for the geo AND this merchant must have a `merchant_method_spreads` row for it — a missing PAY-IN spread returns 400 METHOD_NOT_CONTRACTED.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 3049,\n \"currency\": \"INR\",\n \"geo\": 3,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-in-intent-12345\",\n \"clientReference\": \"customer-7781\",\n \"paymentMethod\": \"upi_intent\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create PayIn (India, UPI app links)", "request": { "name": "Create PayIn (India, UPI app links)", "description": { "content": "Same as Create PayIn (India, UPI Intent), plus the optional `includeUpiAppLinks: true` (v2.14).\n\nWhen the order has `upiIntentLink` (a `upi` / `upi_intent` order served by an Atlas trader card), the 201 response adds `upiAppLinks { phonepe, paytm }` right before `checkout`: deep links that open the PhonePe and Paytm \"send money to a UPI ID\" screens with the payee and the locked payable amount filled in. Use them as button hrefs unchanged and keep `upiIntentLink` and the QR on screen as the fallback; the app routes are not public APIs of those apps.\n\nThe flag is ignored (never rejected) on `imps` and externally routed orders. Without it the response is byte-identical to v2.13. See https://api.atlas-online.io/docs/india#payment-screen.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 3049,\n \"currency\": \"INR\",\n \"geo\": 3,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-in-intent-12345\",\n \"clientReference\": \"customer-7781\",\n \"paymentMethod\": \"upi_intent\",\n \"includeUpiAppLinks\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create PayIn (India, IMPS)", "request": { "name": "Create PayIn (India, IMPS)", "description": { "content": "Reserves a payment destination for an inbound payment on the India IMPS rail (v2.2).\n\n`paymentMethod: \"imps\"` selects a bank-transfer card: the response carries `accountNumber` + `ifscCode` (+ `bankName`, `ownerName`) and no QR / deep link. Amounts are whole INR. Confirm with the payer's UTR via POST /pay-in/{payInId}/utr. Since v2.9 the response contains only the keys that apply to the rail.", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 5000,\n \"currency\": \"INR\",\n \"geo\": 3,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-in-imps-12345\",\n \"clientReference\": \"customer-7781\",\n \"paymentMethod\": \"imps\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create PayIn (India, hosted checkout)", "request": { "name": "Create PayIn (India, hosted checkout)", "description": { "content": "Reserves a payment destination for an inbound payment and requests an Atlas-hosted payment page (v2.5, scope widened in v2.6) — India geo, methods upi / upi_intent / imps.\n\nThe optional `checkout` object opts into the hosted page: `returnUrl` (required if `checkout` is present, HTTPS, <=1024 chars, no userinfo/fragment; supports the `{PAY_IN_ID}` placeholder), `cancelUrl` (optional, falls back to `returnUrl`), `locale` (optional BCP-47; unknown values fall back to the geo default — never a 400).\n\nScope gate: `checkout` is accepted ONLY for `geo=India` on one of the three India methods (`paymentMethod=upi`, `upi_intent` or `imps` — widened in v2.6 from the literal `upi`) routed to the internal trader pool; otherwise the whole request is rejected with `400 CHECKOUT_NOT_SUPPORTED` and no PayIn is created. When `checkout` is present, `expiresIn` must be within 300-3600 seconds.\n\nThe 201 response gains a trailing `checkout { url, expiresAt, locale, embedUrl }` object — present ONLY when checkout was requested and accepted (existing integrations that omit `checkout` see a byte-identical response). `embedUrl` is v2.7 and is APPENDED after `locale`; see the request 'Create PayIn (India, embedded checkout)' for what to do with it. The payer is returned to `returnUrl` for EVERY outcome (success / not confirmed / expired / start again) via `302 GET returnUrl?payInId=…&merchantOrderId=…`; only an explicit payer cancel goes to `cancelUrl`. The redirect is NOT a confirmation — credit orders only from the signed `pay_in.completed` webhook or `GET /pay-in/{payInId}/status`. Submitting a UTR on the hosted page may extend `expiresAt` once by up to 30 minutes.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 3049,\n \"currency\": \"INR\",\n \"geo\": 3,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-in-checkout-12345\",\n \"clientReference\": \"customer-7781\",\n \"paymentMethod\": \"upi\",\n \"checkout\": {\n \"returnUrl\": \"https://shop.example/pay/done?o={PAY_IN_ID}\",\n \"cancelUrl\": \"https://shop.example/cart\",\n \"locale\": \"hi\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create PayIn (South Korea, hosted checkout)", "request": { "name": "Create PayIn (South Korea, hosted checkout)", "description": { "content": "Reserves a payment destination for an inbound payment and requests an Atlas-hosted payment page (v2.8) — South Korea geo, methods kor_bank / kakao_pay.\n\nSame `checkout` object and the same rules as the India request: `returnUrl` (required, HTTPS, <=1024 chars, no userinfo/fragment; supports `{PAY_IN_ID}`), `cancelUrl` (optional), `locale` (optional; the Korean page speaks `ko` — the default — and `en`, and an unknown value falls back to `ko` rather than failing). `expiresIn` must be within 300-3600 seconds.\n\nWhat the Korean payer sees: `kor_bank` renders the trader's account number, bank and account holder for a manual bank transfer — no QR, no deep link. `kakao_pay` renders the trader's Kakao Pay QR, plus a tap-to-open button when that payload is a `kakaopay.com` link.\n\nNo UTR: Korea has no transaction-reference concept, so the page shows no reference form — the payer confirms they have paid and the Atlas trader matches the deposit against their own statement. Amounts are whole KRW (no minor unit); fractional values are rejected, never rounded.\n\nThe 201 response gains the same trailing `checkout { url, expiresAt, locale, embedUrl }` object, and `embedUrl` embeds identically — see 'Create PayIn (India, embedded checkout)'. The redirect is NOT a confirmation: credit orders only from the signed `pay_in.completed` webhook or `GET /pay-in/{payInId}/status`.\n\nPrerequisites: `SouthKorea` in the merchant's allowed geos and a merchant spread row for the method (otherwise `METHOD_NOT_CONTRACTED`).\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 150000,\n \"currency\": \"KRW\",\n \"geo\": 4,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-kr-checkout-12345\",\n \"clientReference\": \"customer-7781\",\n \"paymentMethod\": \"kakao_pay\",\n \"checkout\": {\n \"returnUrl\": \"https://shop.example/pay/done?o={PAY_IN_ID}\",\n \"cancelUrl\": \"https://shop.example/cart\",\n \"locale\": \"ko\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create PayIn (India, embedded checkout)", "request": { "name": "Create PayIn (India, embedded checkout)", "description": { "content": "Reserves a payment destination for an inbound payment, requests an Atlas-hosted payment page and EMBEDS it in the merchant's own page (v2.7) — India geo, methods upi / upi_intent / imps.\n\nIdentical request to 'Create PayIn (India, hosted checkout)': embedding is not something you ask for at create time. Every accepted `checkout` response carries BOTH `url` (the page to redirect to) and, since v2.7, `embedUrl` (the same page served embeddable). They are alternatives, not a sequence — redirect to `url` OR embed `embedUrl`.\n\nTo embed, load `https://api.atlas-online.io/embed/v1/atlas.js` on your checkout page and call `Atlas.mount('#atlas-pay', { url: checkout.embedUrl, appearance: {...}, locale: 'en', height: 'auto' })`. The loader creates one cross-origin iframe, keeps its height in sync and raises `ready` / `resize` / `claim` / `success` / `expired` / `failed` / `cancel` / `intent` / `download` / `focus` / `error` events.\n\nThe `success` event is a UI HINT, not a payment: credit the order only from the signed `pay_in.completed` webhook or `GET /pay-in/{payInId}/status`, exactly as for the redirect flow. `cancel` means the payer asked to leave — the frame never navigates, the routing is yours.\n\nPrerequisite that is NOT part of this HMAC contract: the origin doing the framing must be registered for the merchant account with `PUT /api/merchant/checkout-settings/origins` (merchant portal session, not HMAC; https only, host[+port], apex AND wildcard listed separately, max 10). An unregistered origin gets a readable 403 page inside the frame and the loader raises `error {code:'NO_RESPONSE'}` after ~8 s. The saved appearance theme is written the same way (`PUT /api/merchant/checkout-settings/theme`) and applies to the hosted page and the embed alike; `mount({appearance})` overrides it per page.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 3049,\n \"currency\": \"INR\",\n \"geo\": 3,\n \"expiresIn\": 900,\n \"merchantOrderId\": \"order-in-embed-12345\",\n \"clientReference\": \"customer-7781\",\n \"paymentMethod\": \"upi\",\n \"checkout\": {\n \"returnUrl\": \"https://shop.example/pay/done?o={PAY_IN_ID}\",\n \"cancelUrl\": \"https://shop.example/cart\",\n \"locale\": \"en\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "status", "description": "", "item": [ { "id": "9a91379b-8ddf-43da-9e28-bc8a3a2963d2", "name": "Get PayIn status by merchantOrderId", "request": { "name": "Get PayIn status by merchantOrderId", "description": { "content": "v2.19. Finds a pay-in by your own merchantOrderId and returns the same body as Get PayIn status (payInId included). Use it when POST /api/merchant/pay-in timed out and you have no payInId: 200 = the pay-in exists, do not create it again; 404 = it was not created, repeat the create with the same merchantOrderId and the same body (create is idempotent by merchantOrderId).\n\nSend the value URL-encoded as a query component: `+` as `%2B` (a raw `+` is read as a space), `&` as `%26`, `#` as `%23`, `%` as `%25`. In Postman, type these characters already encoded. The query string is not signed: the canonical string is `.` as for every GET, so the collection pre-request script signs this request unchanged.", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a352a737-9500-4760-8a35-f4e16759751f", "name": "Current status, the same body as the by-id status endpoint.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "2026-10-22" } ], "body": "{\n \"payInId\": \"1c75c312-93f3-4b34-903e-10fb38a56bec\",\n \"displayId\": \"PI00000007\",\n \"status\": \"Completed\",\n \"amount\": 5000.00,\n \"requestedAmount\": 5000.00,\n \"amountAdjustment\": 0,\n \"originalAmount\": 5000.00,\n \"currency\": \"ARS\",\n \"createdAt\": \"2026-04-14T13:13:36.837Z\",\n \"expiresAt\": \"2026-04-14T13:28:36.837Z\",\n \"completedAt\": \"2026-04-14T13:13:50.651Z\",\n \"expiredAt\": null,\n \"payerName\": \"Juan Martinez\",\n \"isManualConfirmation\": false,\n \"geo\": \"Argentina\",\n \"requiresManualConfirmation\": false,\n \"qrPayload\": null,\n \"clientReference\": \"customer-7781\",\n \"exchangeRate\": 1000,\n \"commissionRate\": 5,\n \"amountUsdt\": 4.75\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99ac134f-1bb2-4136-9cd2-962de63db913", "name": "merchantOrderId is missing or blank.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"VALIDATION_ERROR\",\n \"message\": \"merchantOrderId is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99d33f68-899d-4a20-8f2c-b2e2d62df8ba", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdd76865-e438-44ad-a6fc-c57e2d6fc607", "name": "No order with this merchantOrderId on your account.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"NOT_FOUND\",\n \"message\": \"PayIn not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "cancel", "description": "", "item": [ { "id": "da42f618-5d3f-43e3-bd88-42c1e1bd148f", "name": "Cancel PayIn by merchantOrderId", "request": { "name": "Cancel PayIn by merchantOrderId", "description": { "content": "Cancels a pay-in you no longer need (v2.20): you sent the same order to several providers and kept whichever answered first, or you never showed the payer the payment details. WaitingPayment or Expired moves to Failed for good (a late payment no longer completes it); 200 returns the same body as Get PayIn status. An already Failed pay-in returns the same 200, so the call is safe to retry. No pay_in.failed webhook is sent for a cancel: the 200 response is the confirmation.\n\n409 PAYIN_COMPLETED: the payment was received, credit the order. 409 PAYMENT_REPORTED: a payment was reported for the order and Atlas support settles it; the order goes on normally. Do not retry either. 409 CANCEL_FAILED: Atlas could not confirm the cancellation with the payment network right now; the pay-in stays WaitingPayment and can still complete or expire; retry after a delay. 409 CONCURRENT_UPDATE: retry after a short delay.\n\nNo request body: the canonical string is `.` as for a GET, so the collection pre-request script signs this request unchanged.\n\nThe merchantOrderId is matched exactly (case-sensitive, not trimmed) among your own orders. Send it URL-encoded as a query component: `+` as `%2B`, `&` as `%26`, `#` as `%23`, `%` as `%25`. In Postman, type these characters already encoded.", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "d9ccc424-a365-4a38-a194-9a8982473bec", "name": "Cancelled (or already Failed): the same body as Get PayIn status, status Failed.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "2026-11-04" } ], "body": "{\n \"payInId\": \"5e7f1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b\",\n \"displayId\": \"PI00000041\",\n \"status\": \"Failed\",\n \"amount\": 5000.00,\n \"requestedAmount\": 5000.00,\n \"amountAdjustment\": 0,\n \"originalAmount\": 5000.00,\n \"currency\": \"ARS\",\n \"createdAt\": \"2026-11-04T10:00:00.000Z\",\n \"expiresAt\": \"2026-11-04T10:15:00.000Z\",\n \"completedAt\": null,\n \"expiredAt\": null,\n \"payerName\": null,\n \"isManualConfirmation\": false,\n \"geo\": \"Argentina\",\n \"requiresManualConfirmation\": false,\n \"qrPayload\": null,\n \"clientReference\": \"customer-7781\",\n \"exchangeRate\": 1000,\n \"commissionRate\": 5,\n \"amountUsdt\": 4.75\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8300b12d-4413-42e3-a200-393b1bb7eee1", "name": "merchantOrderId is missing or blank.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"VALIDATION_ERROR\",\n \"message\": \"merchantOrderId is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91570a9c-0379-4c4e-a233-14f4d542528c", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"INVALID_SIGNATURE\",\n \"message\": \"Signature verification failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87e51ff8-c5fa-4f92-83c8-f7a6abf9c25b", "name": "No pay-in with this id on your merchant account.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"NOT_FOUND\",\n \"message\": \"PayIn not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "446909f1-d1d9-41eb-ad75-26afe22b6bce", "name": "Not cancelled: the pay-in is completed.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"PAYIN_COMPLETED\",\n \"message\": \"PI00000041 is completed — a completed pay-in cannot be cancelled.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9207f205-f50d-45f9-bd93-aa6e28ce1f35", "name": "Not cancelled: a payment was reported for the order.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"PAYMENT_REPORTED\",\n \"message\": \"A payment was reported for PI00000041 — it is settled by Atlas support and cannot be cancelled.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5370c1d-a568-45b1-adc9-efae6c8f2ddf", "name": "Not cancelled: the cancellation could not be confirmed right now, the pay-in stays open. Retry later.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"CANCEL_FAILED\",\n \"message\": \"PI00000041 could not be cancelled right now — it stays open. Retry later.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{payInId}", "description": "", "item": [ { "name": "status", "description": "", "item": [ { "id": "eddf0392-f459-4db8-97c2-805571aba003", "name": "Get PayIn status", "request": { "name": "Get PayIn status", "description": { "content": "v2.0: response now includes `clientReference` (echo) and `qrPayload`.", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payInId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ae9dc854-c2ad-47dc-94b9-5b5ea8591ee3", "name": "Current PayIn status.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payInId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "2026-10-06" } ], "body": "{\n \"payInId\": \"\",\n \"displayId\": \"\",\n \"status\": \"Expired\",\n \"amount\": \"\",\n \"currency\": \"ARS\",\n \"createdAt\": \"\",\n \"expiresAt\": \"\",\n \"geo\": \"Argentina\",\n \"isManualConfirmation\": \"\",\n \"requiresManualConfirmation\": \"\",\n \"completedAt\": \"\",\n \"expiredAt\": \"\",\n \"payerName\": \"\",\n \"utr\": \"\",\n \"qrPayload\": \"\",\n \"clientReference\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c158c89-465b-40b4-8cf8-28053a9a9496", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payInId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd526808-7883-423f-af3b-7d01d7585728", "name": "Resource not found or not owned by caller.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payInId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "cancel", "description": "", "item": [ { "id": "9b567231-9f6c-4ce2-8d9c-65e2f7912986", "name": "Cancel PayIn", "request": { "name": "Cancel PayIn", "description": { "content": "Cancels a pay-in you no longer need (v2.20): you sent the same order to several providers and kept whichever answered first, or you never showed the payer the payment details. WaitingPayment or Expired moves to Failed for good (a late payment no longer completes it); 200 returns the same body as Get PayIn status. An already Failed pay-in returns the same 200, so the call is safe to retry. No pay_in.failed webhook is sent for a cancel: the 200 response is the confirmation.\n\n409 PAYIN_COMPLETED: the payment was received, credit the order. 409 PAYMENT_REPORTED: a payment was reported for the order and Atlas support settles it; the order goes on normally. Do not retry either. 409 CANCEL_FAILED: Atlas could not confirm the cancellation with the payment network right now; the pay-in stays WaitingPayment and can still complete or expire; retry after a delay. 409 CONCURRENT_UPDATE: retry after a short delay.\n\nNo request body: the canonical string is `.` as for a GET, so the collection pre-request script signs this request unchanged.", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payInId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "26f2784f-d704-4b34-b21c-d4c936018cea", "name": "Cancelled (or already Failed): the same body as Get PayIn status, status Failed.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payInId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "2026-11-04" } ], "body": "{\n \"payInId\": \"5e7f1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b\",\n \"displayId\": \"PI00000041\",\n \"status\": \"Failed\",\n \"amount\": 5000.00,\n \"requestedAmount\": 5000.00,\n \"amountAdjustment\": 0,\n \"originalAmount\": 5000.00,\n \"currency\": \"ARS\",\n \"createdAt\": \"2026-11-04T10:00:00.000Z\",\n \"expiresAt\": \"2026-11-04T10:15:00.000Z\",\n \"completedAt\": null,\n \"expiredAt\": null,\n \"payerName\": null,\n \"isManualConfirmation\": false,\n \"geo\": \"Argentina\",\n \"requiresManualConfirmation\": false,\n \"qrPayload\": null,\n \"clientReference\": \"customer-7781\",\n \"exchangeRate\": 1000,\n \"commissionRate\": 5,\n \"amountUsdt\": 4.75\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1685d5de-2125-49b9-994f-dbd765f74c83", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payInId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"INVALID_SIGNATURE\",\n \"message\": \"Signature verification failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d104fe0-b3ca-4776-ae34-986d99527518", "name": "No pay-in with this id on your merchant account.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payInId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"NOT_FOUND\",\n \"message\": \"PayIn not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e25ee60d-b943-4753-b460-43987a7f8e3a", "name": "Not cancelled: the pay-in is completed.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payInId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"PAYIN_COMPLETED\",\n \"message\": \"PI00000041 is completed — a completed pay-in cannot be cancelled.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "696b8974-6e54-44b4-a1e3-6c5bba0532fe", "name": "Not cancelled: a payment was reported for the order.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payInId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"PAYMENT_REPORTED\",\n \"message\": \"A payment was reported for PI00000041 — it is settled by Atlas support and cannot be cancelled.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b4d4e42-6e16-45fb-906a-9ca1c5b56316", "name": "Not cancelled: the cancellation could not be confirmed right now, the pay-in stays open. Retry later.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payInId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"CANCEL_FAILED\",\n \"message\": \"PI00000041 could not be cancelled right now — it stays open. Retry later.\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "utr", "description": "", "item": [ { "id": "d57e0e9b-1135-4af0-9d9e-192c190632bd", "name": "Submit payer UTR", "request": { "name": "Submit payer UTR", "description": { "content": "Pushes a Unique Transaction Reference supplied by the payer at checkout.\nRecords the UTR on the PayIn and returns the current status atomically.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "utr" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payInId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"utr\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f18617ef-4a27-4007-98ea-885c188fdbc7", "name": "UTR recorded.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "utr" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payInId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"utr\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payInId\": \"\",\n \"displayId\": \"\",\n \"status\": \"Failed\",\n \"utr\": \"\",\n \"requiresManualConfirmation\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c21b39e-c1e3-4452-a87b-b9c4e90b430c", "name": "Validation or business-rule failure.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "utr" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payInId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"utr\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ec9facd-50c3-4173-846b-51c1b6842e5a", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "utr" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payInId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"utr\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d5426e3-7536-4e49-8a94-b3816b5744cb", "name": "Resource not found or not owned by caller.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-in", ":payInId", "utr" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payInId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"utr\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "pay-out", "description": "", "item": [ { "id": "d0134bbf-b512-4b39-9d8c-ef96b1f40b33", "name": "Create PayOut (Argentina)", "request": { "name": "Create PayOut (Argentina)", "description": { "content": "Submits an outbound payment — Argentina geo.\n\nv2.0: `clientReference` is REQUIRED. Only send `recipientCbu`; do NOT send VE fields.\nA pay-out submitted before balance is funded is ACCEPTED (201) with status `AwaitingFunds`.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipientName\": \"Maria Garcia Lopez\",\n \"amount\": 5000.00,\n \"currency\": \"ARS\",\n \"geo\": 1,\n \"expiresIn\": 1800,\n \"merchantOrderId\": \"payout-67890\",\n \"clientReference\": \"customer-7781\",\n \"recipientCbu\": \"0000177501057000189625\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "f5b3fd03-8851-4a87-972a-8bbb5be45e34", "name": "PayOut created.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipientName\": \"Maria Garcia Lopez\",\n \"amount\": 5000.00,\n \"currency\": \"ARS\",\n \"geo\": 1,\n \"expiresIn\": 1800,\n \"merchantOrderId\": \"payout-67890\",\n \"clientReference\": \"customer-7781\",\n \"recipientCbu\": \"0000177501057000189625\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "2026-10-06" } ], "body": "{\n \"payOutId\": \"\",\n \"displayId\": \"\",\n \"amountFiat\": \"\",\n \"amountUsdt\": \"\",\n \"currency\": \"ARS\",\n \"expiresAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eceb6feb-a5ab-48dc-9331-5ee385b68950", "name": "Validation or business-rule failure.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipientName\": \"Maria Garcia Lopez\",\n \"amount\": 5000.00,\n \"currency\": \"ARS\",\n \"geo\": 1,\n \"expiresIn\": 1800,\n \"merchantOrderId\": \"payout-67890\",\n \"clientReference\": \"customer-7781\",\n \"recipientCbu\": \"0000177501057000189625\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc7575d4-a20e-424c-aedd-45d8de0cf70b", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipientName\": \"Maria Garcia Lopez\",\n \"amount\": 5000.00,\n \"currency\": \"ARS\",\n \"geo\": 1,\n \"expiresIn\": 1800,\n \"merchantOrderId\": \"payout-67890\",\n \"clientReference\": \"customer-7781\",\n \"recipientCbu\": \"0000177501057000189625\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0134bbf-b512-4b39-9d8c-ef96b1f40b34", "name": "Create PayOut (Venezuela)", "request": { "name": "Create PayOut (Venezuela)", "description": { "content": "Submits an outbound payment — Venezuela geo.\n\nv2.0: `clientReference` is REQUIRED. All four VE recipient fields are required:\n`recipientPhone`, `recipientCedula`, `recipientBank`, `recipientAccountNumber`.\nDo NOT send `recipientCbu` — it will be rejected with 400 VALIDATION_ERROR.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipientName\": \"Carlos Rodríguez\",\n \"amount\": 1500.00,\n \"currency\": \"VES\",\n \"geo\": 2,\n \"expiresIn\": 1800,\n \"merchantOrderId\": \"payout-ve-12345\",\n \"clientReference\": \"customer-7781\",\n \"recipientPhone\": \"+584121234567\",\n \"recipientCedula\": \"V-12345678\",\n \"recipientBank\": \"Banesco\",\n \"recipientAccountNumber\": \"01020123456789012345\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create PayOut (SouthKorea)", "request": { "name": "Create PayOut (SouthKorea)", "description": { "content": "Submits an outbound payment — South Korea geo (v2.3). kor_bank bank transfer is the ONLY rail.\n\nRequired recipient fields: `recipientAccountNumber` (5-20 digits; hyphens/spaces accepted) + `recipientBank`.\nDo NOT send `recipientCbu`, `recipientPhone`, `recipientCedula` or `recipientIfsc` — they are rejected with 400 VALIDATION_ERROR.\n`paymentMethod` may be omitted (defaults to kor_bank); \"kakao_pay\" is rejected. Amount must be a whole number of KRW.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipientName\": \"Kim Minseo\",\n \"amount\": 150000,\n \"currency\": \"KRW\",\n \"geo\": 4,\n \"expiresIn\": 1800,\n \"merchantOrderId\": \"payout-kr-12345\",\n \"clientReference\": \"customer-7781\",\n \"recipientAccountNumber\": \"110-123-456789\",\n \"recipientBank\": \"KB Kookmin Bank\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create PayOut (India)", "request": { "name": "Create PayOut (India)", "description": { "content": "Submits an outbound payment — India geo, IMPS rail (v2.2). Since v2.6 India has TWO pay-out rails, selected with `paymentMethod`; `imps` is the default when it is omitted.\n\nRequired recipient fields on this rail: `recipientAccountNumber` + `recipientBank` + `recipientIfsc` (11-char IFSC, AAAA0XXXXXX).\nDo NOT send `recipientCbu`, `recipientPhone`, `recipientCedula` or `recipientUpiVpa` — they are rejected with 400 VALIDATION_ERROR (`recipientUpiVpa is only valid for paymentMethod upi`).\n`paymentMethod` may be omitted (defaults to imps) or sent as \"imps\"; anything other than imps/upi returns `paymentMethod '' is not available for India pay-outs; use imps or upi`. Amount must be a whole number of INR.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipientName\": \"Ravi Kumar\",\n \"amount\": 10000,\n \"currency\": \"INR\",\n \"geo\": 3,\n \"expiresIn\": 1800,\n \"merchantOrderId\": \"payout-in-12345\",\n \"clientReference\": \"customer-7781\",\n \"recipientAccountNumber\": \"40145477128\",\n \"recipientBank\": \"HDFC Bank\",\n \"recipientIfsc\": \"HDFC0001234\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Create PayOut (India, UPI)", "request": { "name": "Create PayOut (India, UPI)", "description": { "content": "Submits an outbound payment — India geo, UPI rail (v2.6).\n\n`paymentMethod: \"upi\"` is REQUIRED to select the rail (omitting it selects imps), and `recipientUpiVpa` (UPI ID in `handle@psp` form, stored lower-cased) is the WHOLE recipient object.\nDo NOT send `recipientAccountNumber`, `recipientBank` or `recipientIfsc` — `recipientAccountNumber, recipientBank and recipientIfsc are not valid for India UPI pay-outs; send recipientUpiVpa only`. `recipientCbu` / `recipientPhone` / `recipientCedula` are rejected as on every India pay-out, and `recipientUpiVpa` outside India returns `recipientUpiVpa is only valid for India`. A malformed VPA returns `recipientUpiVpa has invalid UPI ID format (expected handle@psp)`. Amount must be a whole number of INR.\n\nHow it settles: an Atlas trader sends the money from their own UPI app to that VPA and uploads the proof. You are notified by the same `pay_out.completed` webhook, which carries `recipientUpiVpa` immediately after `recipientIfsc` (itself still present as null). The 201 response and GET /pay-out/{payOutId}/status echo the same field; it is omitted entirely on every other geo/rail.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-out" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipientName\": \"Ravi Kumar\",\n \"amount\": 10000,\n \"currency\": \"INR\",\n \"geo\": 3,\n \"expiresIn\": 1800,\n \"merchantOrderId\": \"payout-in-upi-12345\",\n \"clientReference\": \"customer-7781\",\n \"recipientUpiVpa\": \"ravi.kumar@ybl\",\n \"paymentMethod\": \"upi\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "status", "description": "", "item": [ { "id": "abc68f0f-c231-4347-987e-8ecce2befc94", "name": "Get PayOut status by merchantOrderId", "request": { "name": "Get PayOut status by merchantOrderId", "description": { "content": "v2.19. Finds a pay-out by your own merchantOrderId and returns the same body as Get PayOut status (no payOutId field; displayId identifies the pay-out). Use it when POST /api/merchant/pay-out timed out and you have no payOutId: 200 = the pay-out exists, do not create it again; 404 = it was not created, repeat the create with the same merchantOrderId and the same body (create is idempotent by merchantOrderId).\n\nSend the value URL-encoded as a query component: `+` as `%2B` (a raw `+` is read as a space), `&` as `%26`, `#` as `%23`, `%` as `%25`. In Postman, type these characters already encoded. The query string is not signed: the canonical string is `.` as for every GET, so the collection pre-request script signs this request unchanged.", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-out", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "39297570-138b-4c33-ab77-0dd02fddc0da", "name": "Current status, the same body as the by-id status endpoint.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-out", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "2026-10-22" } ], "body": "{\n \"displayId\": \"PO00000001\",\n \"status\": \"Completed\",\n \"amountFiat\": 5000.00,\n \"currency\": \"ARS\",\n \"amountUsdt\": 4.85,\n \"geo\": \"Argentina\",\n \"recipientCbu\": \"0000177501057000189625\",\n \"recipientName\": \"Maria Garcia Lopez\",\n \"clientReference\": \"customer-7781\",\n \"createdAt\": \"2026-04-14T15:30:00Z\",\n \"expiresAt\": \"2026-04-14T16:00:00Z\",\n \"completedAt\": \"2026-04-14T15:52:14Z\",\n \"expiredAt\": null,\n \"supportNote\": \"Proof verified\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ea135ea-8023-41ca-93c6-75ada4ac213d", "name": "merchantOrderId is missing or blank.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-out", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"VALIDATION_ERROR\",\n \"message\": \"merchantOrderId is required\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f15208aa-e2e3-4fd9-8e3f-b06e08fc8276", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-out", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0809c43a-7812-4b63-b767-499f9e342299", "name": "No order with this merchantOrderId on your account.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-out", "status" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "merchantOrderId", "value": "ORDER-1", "disabled": false, "description": { "content": "(Required) The merchantOrderId sent on create. Matched exactly (case-sensitive, not trimmed). URL-encode it.", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"NOT_FOUND\",\n \"message\": \"PayOut not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{payOutId}", "description": "", "item": [ { "name": "status", "description": "", "item": [ { "id": "d37cf6c8-38d8-4e46-9545-e34d7dc33bc9", "name": "Get PayOut status", "request": { "name": "Get PayOut status", "description": { "content": "v2.0: response now includes `geo`, VE recipient fields, `recipientAccountNumber`, and `clientReference`.\n`AwaitingFunds` is a valid status — the pay-out is accepted but pending balance funding.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "pay-out", ":payOutId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payOutId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c7a56022-1ca3-4ae9-aca9-6ff9e98dc6cb", "name": "Current PayOut status.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-out", ":payOutId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payOutId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "2026-10-06" } ], "body": "{\n \"displayId\": \"\",\n \"status\": \"Expired\",\n \"amountFiat\": \"\",\n \"currency\": \"ARS\",\n \"amountUsdt\": \"\",\n \"recipientName\": \"\",\n \"createdAt\": \"\",\n \"expiresAt\": \"\",\n \"geo\": \"Argentina\",\n \"recipientCbu\": \"\",\n \"recipientPhone\": \"\",\n \"recipientCedula\": \"\",\n \"recipientBank\": \"\",\n \"recipientAccountNumber\": \"\",\n \"clientReference\": \"\",\n \"completedAt\": \"\",\n \"expiredAt\": \"\",\n \"supportNote\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ae2634f-4626-4880-8595-9b56a5670c2b", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-out", ":payOutId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payOutId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3567795f-ddc9-4bca-ac6f-4fce218c3c40", "name": "Resource not found or not owned by caller.", "originalRequest": { "url": { "path": [ "api", "merchant", "pay-out", ":payOutId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "payOutId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "disputes", "description": "", "item": [ { "id": "bbea0cfd-99ae-411b-ae2e-292974aa74c8", "name": "Open dispute", "request": { "name": "Open dispute", "description": { "content": "Contests a completed PayIn or PayOut. The platform holds the underlying\nfunds until the dispute is resolved. A 24-hour evidence deadline applies.\n\nv2.0: `disputeAmount` is REQUIRED. May be partial (0 < disputeAmount <= transaction amount).\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "disputes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionType\": \"PayIn\",\n \"transactionId\": \"\",\n \"reason\": \"\",\n \"merchantOrderId\": \"\",\n \"disputeAmount\": 750.00\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "d236c858-edea-4056-9f70-6d8956fc0550", "name": "Dispute opened.", "originalRequest": { "url": { "path": [ "api", "merchant", "disputes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionType\": \"PayIn\",\n \"transactionId\": \"\",\n \"reason\": \"\",\n \"merchantOrderId\": \"\",\n \"disputeAmount\": 750.00\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "2026-10-06" } ], "body": "{\n \"disputeId\": \"\",\n \"displayId\": \"\",\n \"status\": \"PendingEvidence\",\n \"evidenceDeadline\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e6854e4-a626-45bd-9230-346862400747", "name": "Validation or business-rule failure.", "originalRequest": { "url": { "path": [ "api", "merchant", "disputes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionType\": \"PayIn\",\n \"transactionId\": \"\",\n \"reason\": \"\",\n \"merchantOrderId\": \"\",\n \"disputeAmount\": 750.00\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bc2d8f6-889a-4c58-b72e-4cf8b30fdd6a", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "disputes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"transactionType\": \"PayIn\",\n \"transactionId\": \"\",\n \"reason\": \"\",\n \"merchantOrderId\": \"\",\n \"disputeAmount\": 750.00\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "02cd609b-ce25-4298-a4a3-56eca67867c2", "name": "Get dispute", "request": { "name": "Get dispute", "description": {}, "url": { "path": [ "api", "merchant", "disputes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ec36aa50-9a6c-4d1d-a347-92030a258674", "name": "Dispute envelope with the merchant-visible message thread.", "originalRequest": { "url": { "path": [ "api", "merchant", "disputes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "2026-10-06" } ], "body": "{\n \"id\": \"\",\n \"displayId\": \"\",\n \"merchantOrderId\": \"\",\n \"disputeType\": \"PayIn\",\n \"transactionId\": \"\",\n \"amountFiat\": \"\",\n \"currency\": \"VES\",\n \"geo\": \"Argentina\",\n \"merchantReason\": \"\",\n \"status\": \"UnderReview\",\n \"evidenceDeadline\": \"\",\n \"isOverdue\": \"\",\n \"resolution\": \"\",\n \"createdAt\": \"\",\n \"resolvedAt\": \"\",\n \"merchantThread\": [\n {\n \"id\": \"\",\n \"senderType\": \"MerchantApi\",\n \"senderName\": \"\",\n \"body\": \"\",\n \"createdAt\": \"\",\n \"attachments\": []\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf4037eb-3236-46fd-b3d7-2c31fe53f69e", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "disputes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ba68230-f67b-49ee-9230-524109462334", "name": "Resource not found or not owned by caller.", "originalRequest": { "url": { "path": [ "api", "merchant", "disputes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "messages", "description": "", "item": [ { "id": "2fdc5744-b407-4f77-b3b7-c7d5bc7d7543", "name": "Post message or evidence", "request": { "name": "Post message or evidence", "description": { "content": "Posts a text message and up to 10 attachment files to the dispute thread.\nOnly the first 10 files are stored; files after the tenth are dropped without an error.\n\nA dispute that does not exist or belongs to another merchant gets 404 NOT_FOUND; files are stored only after that check.\n\nSigning: HMAC-SHA256 over the bytes of `\"{timestamp}.\"` followed by the encoded multipart body exactly as sent, boundaries and file bytes included, with no text decoding. The collection script encodes text fields itself and signs them; Postman cannot sign file fields, so send files from your own client.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "disputes", ":id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Message text.", "type": "text/plain" }, "key": "body", "value": "", "type": "text" }, { "description": { "content": "Up to 10 attachments per request, combined size up to 50 MB. Files after the tenth are dropped without an error. Disabled here: Postman cannot sign file fields.", "type": "text/plain" }, "key": "files", "value": ",", "type": "text", "disabled": true } ] }, "auth": null }, "response": [ { "id": "72771a1e-89fe-44b3-a203-efa36a34f969", "name": "Message accepted.", "originalRequest": { "url": { "path": [ "api", "merchant", "disputes", ":id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Message text.", "type": "text/plain" }, "key": "body", "value": "", "type": "text" }, { "description": { "content": "Up to 10 attachments per request, combined size up to 50 MB. Files after the tenth are dropped without an error. Disabled here: Postman cannot sign file fields.", "type": "text/plain" }, "key": "files", "value": ",", "type": "text", "disabled": true } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab110e66-46e3-4970-8430-fb048e1cb2c6", "name": "Validation or business-rule failure.", "originalRequest": { "url": { "path": [ "api", "merchant", "disputes", ":id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Message text.", "type": "text/plain" }, "key": "body", "value": "", "type": "text" }, { "description": { "content": "Up to 10 attachments per request, combined size up to 50 MB. Files after the tenth are dropped without an error. Disabled here: Postman cannot sign file fields.", "type": "text/plain" }, "key": "files", "value": ",", "type": "text", "disabled": true } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ea12c96-3ed0-49c2-bced-b126918a4c0b", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "disputes", ":id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) Message text.", "type": "text/plain" }, "key": "body", "value": "", "type": "text" }, { "description": { "content": "Up to 10 attachments per request, combined size up to 50 MB. Files after the tenth are dropped without an error. Disabled here: Postman cannot sign file fields.", "type": "text/plain" }, "key": "files", "value": ",", "type": "text", "disabled": true } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a36d58f-e867-42eb-acd4-c969f3541b70", "name": "Get dispute messages", "request": { "name": "Get dispute messages", "description": {}, "url": { "path": [ "api", "merchant", "disputes", ":id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0fc289a9-24cd-4c11-8706-8c4c5d590239", "name": "Merchant-visible thread.", "originalRequest": { "url": { "path": [ "api", "merchant", "disputes", ":id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"messages\": [\n {\n \"id\": \"\",\n \"senderType\": \"MerchantApi\",\n \"senderName\": \"\",\n \"body\": \"\",\n \"createdAt\": \"\",\n \"attachments\": []\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f808e2b-41f3-456b-8cc1-38e6636ff8c8", "name": "Authentication failure (missing / invalid headers).", "originalRequest": { "url": { "path": [ "api", "merchant", "disputes", ":id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "612fb8db-9591-4e41-bbfd-ebeadc421040", "name": "Resource not found or not owned by caller.", "originalRequest": { "url": { "path": [ "api", "merchant", "disputes", ":id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "banks", "description": "", "item": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "List banks / wallets for a geo", "request": { "name": "List banks / wallets for a geo", "description": { "content": "Returns the canonical bank and wallet directory for a given geo.\nArgentina returns an empty array; Venezuela returns banks + wallets with stable `code` values.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "banks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "geo", "value": "Venezuela", "disabled": false, "description": { "content": "(Required) Argentina or Venezuela (or 1 / 2)", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Bank/wallet directory for the geo.", "originalRequest": { "url": { "path": [ "api", "merchant", "banks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "geo", "value": "Venezuela" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "2026-10-06" } ], "body": "[\n { \"code\": \"0102\", \"name\": \"Banco de Venezuela\", \"kind\": \"Bank\" },\n { \"code\": \"0134\", \"name\": \"Banesco\", \"kind\": \"Bank\" },\n { \"code\": \"W001\", \"name\": \"Pago Móvil\", \"kind\": \"Wallet\" }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "payment-methods", "description": "", "item": [ { "id": "c3d4e5f6-a7b8-9012-cdef-123456789012", "name": "Get payment methods for a geo", "request": { "name": "Get payment methods for a geo", "description": { "content": "NEW in v2.0. Returns the payment methods available to this merchant for the requested geo.\nResponse shape: `[{ name, type }]` where `type` is the rail (e.g. `ven_bank`, `cvu`).\nThe `type` value can be passed as `paymentMethod` on PayIn create.\n", "type": "text/plain" }, "url": { "path": [ "api", "merchant", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "geo", "value": "Venezuela", "disabled": false, "description": { "content": "(Required) Argentina or Venezuela (or 1 / 2)", "type": "text/plain" } } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d4e5f6a7-b8c9-0123-def0-234567890123", "name": "Available payment methods for the geo.", "originalRequest": { "url": { "path": [ "api", "merchant", "payment-methods" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "geo", "value": "Venezuela" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Api-Version", "value": "2026-10-06" } ], "body": "[\n { \"name\": \"Banesco\", \"type\": \"ven_bank\" },\n { \"name\": \"Pago Móvil\", \"type\": \"ven_bank\" },\n { \"name\": \"Zinli\", \"type\": \"ven_bank_account\" }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "balance", "item": [ { "id": "d37cf6c8-38d8-4e46-9545-e34d7dc33bc9", "name": "Get balance", "request": { "name": "Get balance", "description": "", "url": { "path": [ "api", "merchant", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payOutId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/merchant/balance" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "withdrawals", "item": [ { "id": "d57e0e9b-1135-4af0-9d9e-192c190632bd", "name": "Request withdrawal (partial)", "request": { "name": "Request withdrawal (partial)", "description": "", "url": { "path": [ "api", "merchant", "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payInId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/merchant/withdrawals" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 100.00\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d57e0e9b-1135-4af0-9d9e-192c190632bd", "name": "Request withdrawal (whole balance)", "request": { "name": "Request withdrawal (whole balance)", "description": "", "url": { "path": [ "api", "merchant", "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payInId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/merchant/withdrawals" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d37cf6c8-38d8-4e46-9545-e34d7dc33bc9", "name": "List withdrawals", "request": { "name": "List withdrawals", "description": "", "url": { "path": [ "api", "merchant", "withdrawals" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "status", "value": "Completed" } ], "variable": [ { "type": "any", "value": "", "key": "payOutId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/merchant/withdrawals?page=1&pageSize=20&status=Completed" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{withdrawalId}", "item": [ { "id": "d37cf6c8-38d8-4e46-9545-e34d7dc33bc9", "name": "Get withdrawal", "request": { "name": "Get withdrawal", "description": "", "url": { "path": [ "api", "merchant", "withdrawals", ":withdrawalId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "payOutId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/merchant/withdrawals/:withdrawalId" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "transfers", "item": [ { "id": "d9bc7bf6-ec6b-5478-9c8d-8ffd575a742d", "name": "Transfer to pay-out wallet", "request": { "name": "Transfer to pay-out wallet", "description": "", "url": { "path": [ "api", "merchant", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [], "raw": "{{baseUrl}}/api/merchant/transfers" }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"amount\": 250.00,\n \"clientReference\": \"fund-2026-10-12-001\"\n}", "options": { "raw": { "language": "json" } } }, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ec61aadf-6570-5bbe-9995-2e686156f3fa", "name": "List transfers", "request": { "name": "List transfers", "description": "", "url": { "path": [ "api", "merchant", "transfers" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "pageSize", "value": "20" } ], "variable": [], "raw": "{{baseUrl}}/api/merchant/transfers?page=1&pageSize=20" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{transferId}", "item": [ { "id": "196b7bdc-b5ad-597b-bb2e-3330e7b65347", "name": "Get transfer", "request": { "name": "Get transfer", "description": "", "url": { "path": [ "api", "merchant", "transfers", ":transferId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transferId", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ], "raw": "{{baseUrl}}/api/merchant/transfers/:transferId" }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] }