{"info":{"name":"Paymway API","description":"API of the Paymway payment gateway: invoices, static addresses, payments, payouts, subscriptions. Full documentation: https://paymway.com/en/docs\n\n**Getting started**\n\n1. Import the environment file or set the collection variables: `baseUrl` — the gateway URL, `apiKey` — your secret key (`sk_live_…` or `sk_test_…`) from the dashboard, “Integration” section.\n2. The key is sent in the `Authorization: Bearer {{apiKey}}` header — it is set for the whole collection. Payment button and domain methods are called without a key.\n3. Amounts are strings (`\"49.90\"`), dates are ISO 8601 (UTC). Repeating a request with the same `order_id` does not create a duplicate; the `Idempotency-Key` header (disabled in POST requests — enable it) makes retrying any POST safe.\n\n**Errors** — HTTP 4xx/5xx with a body `{\"error\": \"code\", \"message\": \"description\"}`; some also include `details`. `message` is in Russian by default — add the `Accept-Language: en` header to get it in English.\n\n**Webhooks** — headers `X-Webhook-Id`, `X-Webhook-Event`, `X-Webhook-Timestamp`, `X-Webhook-Signature`. Signature: `hex(HMAC_SHA256(webhook_secret, timestamp + \".\" + raw_body))`; reject requests older than 5 minutes.","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","version":"1.0.0"},"auth":{"type":"bearer","bearer":[{"key":"token","value":"{{apiKey}}","type":"string"}]},"variable":[{"key":"baseUrl","value":"https://paymway.com","type":"string"},{"key":"apiKey","value":"","type":"string"}],"item":[{"name":"Invoices","description":"An invoice is a request to pay a specific amount. The customer opens `payment_url`, selects a coin and network and sends funds to a unique address. Once the network confirms the transfer, the amount minus the fee is credited to your balance.\n\npending → confirming → paid\n\n- Status — Meaning\n- `pending` — Awaiting payment\n- `confirming` — Payment detected, waiting for network confirmations\n- `partial` — Part of the amount received; the customer can pay the rest before the invoice expires\n- `paid` / `paid_over` — Paid in full / overpaid — **you can fulfil the order**\n- `underpaid` — Expired with only part of the amount received\n- `expired` — Expired without payment\n- `cancelled` — Cancelled by you\n\nPayments that arrive after the invoice expires, and payments in another coin, are credited to your balance as well — you receive a `payment.confirmed` webhook with `kind` = `late` or `unexpected`.","item":[{"name":"Create an invoice","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/invoices","host":["{{baseUrl}}"],"path":["v1","invoices"]},"body":{"mode":"raw","raw":"{\n  \"amount\": \"49.90\",\n  \"currency\": \"EUR\",\n  \"order_id\": \"1001\",\n  \"description\": \"Payment for order 1001\",\n  \"url_callback\": \"https://shop.example/webhooks/crypto\",\n  \"url_success\": \"https://shop.example/thanks\",\n  \"metadata\": {\n    \"user_id\": 42\n  },\n  \"customer\": {\n    \"company\": \"Acme GmbH\",\n    \"tax_id\": \"DE123456789\",\n    \"email\": \"billing@acme.example\"\n  }\n}","options":{"raw":{"language":"json"}}},"description":"Creates an invoice and returns a payment page link. The amount can be set in fiat — it is converted into the coin the customer selects at the current rate.\n\n**Request body**\n\n- `amount` (string, required) — Amount, e.g. `\"49.90\"`.\n- `currency` (string, required) — Currency of the amount: `USD`, `EUR`, `RUB`, `UAH`, `KZT`, `GBP`, `TRY` or a coin ticker (`USDT`, `BTC`…).\n- `order_id` (string, required) — Your unique order number (up to 128 characters). Ensures idempotency.\n- `lifetime_minutes` (integer) — Payment window: 5 to 43200 minutes (30 days). Default: 60. For invoices longer than a day the coin amount is valid for 60 minutes after the coin is chosen; if the customer comes back later it is re-quoted at the current rate, and a payment detected more than 30 minutes after that window is counted at the rate at the time it is credited.\n- `asset` (string) — Preselect the coin and network, e.g. `tron:USDT` — the customer sees the payment details without the selection step.\n- `allowed_assets` (string[]) — Restrict the payment options, e.g. `[\"tron:USDT\",\"bsc:USDT\"]`.\n- `description` (string) — Description for the customer (up to 500 characters).\n- `url_callback` (string) — Webhook URL for this invoice. Defaults to the URL set in the dashboard.\n- `url_success` (string) — “Back to store” button after payment.\n- `url_return` (string) — Return button for customers who leave without paying.\n- `metadata` (object) — Arbitrary data — returned in responses and webhooks.\n- `region` (string) — Which region’s domain to use in `payment_url`: `ru` — for customers in Russia (via a server in Russia), `global` — for everyone else (via Cloudflare). Defaults to the store setting “Where are your customers”.\n- `lang` (string) — Payment page language: `en`, `ru`, `uk`, `kk`, `uz`, `az`, `es`, `pt` (Brazil), `fr`, `de`, `it`, `pl`, `tr`, `ar`, `fa`, `hi`, `id`, `vi`, `th`, `zh` (Simplified), `ja`, `ko`. A region suffix is allowed (`pt-BR`). Unsupported languages are ignored. The customer can switch the language on the page.\n- `customer` (object) — Buyer details for the invoice and payment receipt (all fields optional): `name` — contact person (up to 200 characters), `company` — company (up to 200), `tax_id` — tax ID: VAT ID, EIN… (up to 64), `address` — address (up to 500), `email` — a link to the receipt is sent there after payment (once, in the `lang` language). Without `email`, the payment page asks the buyer for it before they choose a payment method and saves it to `customer.email`.\n- `buyer_country` (string) — Client country — a two-letter ISO 3166-1 code (`RU`, `KZ`…). If additional payment methods by country are enabled for your store, the customer sees only this country’s methods — regardless of their IP and time zone.\n- `p2p_methods` (string[]) — Which additional payment methods to show (if enabled for your store): method IDs or codes. Omitted — all available for the customer’s country, `[]` — none.\n- `p2p_currency` (string) — Additional payment methods: `invoice` — only in the invoice currency, without conversion (a USD invoice is paid in USD); `convert` — in the customer’s currency at the rate (a customer from a country with its own currency pays in it). Omitted — as in the store settings (`convert` by default). If there are no such methods in the invoice currency, `convert` applies.\n- `crypto` (boolean) — `false` — no crypto payment: only the additional payment methods, if enabled (otherwise the `no_payment_methods` error). Default: `true`.\n- `theme` (string) — Payment page theme: `light` or `dark`. Defaults to the store branding (dashboard → “Branding”).\n\n**Errors:** `validation_error`, `unsupported_currency`, `unknown_asset`, `invalid_country`, `no_payment_methods`, `order_exists`, `rate_unavailable`\n\nDocumentation: https://paymway.com/en/docs#create-invoice"},"response":[{"name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/invoices","host":["{{baseUrl}}"],"path":["v1","invoices"]},"body":{"mode":"raw","raw":"{\n  \"amount\": \"49.90\",\n  \"currency\": \"EUR\",\n  \"order_id\": \"1001\",\n  \"description\": \"Payment for order 1001\",\n  \"url_callback\": \"https://shop.example/webhooks/crypto\",\n  \"url_success\": \"https://shop.example/thanks\",\n  \"metadata\": {\n    \"user_id\": 42\n  },\n  \"customer\": {\n    \"company\": \"Acme GmbH\",\n    \"tax_id\": \"DE123456789\",\n    \"email\": \"billing@acme.example\"\n  }\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n  \"order_id\": \"1001\",\n  \"amount\": \"49.9\",\n  \"currency\": \"EUR\",\n  \"amount_usd\": \"55.24\",\n  \"description\": \"Payment for order 1001\",\n  \"currency_is_fiat\": true,\n  \"payment_url\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n  \"url_success\": \"https://shop.example/thanks\",\n  \"url_return\": null,\n  \"expires_at\": \"2026-11-13T10:04:05.253Z\",\n  \"created_at\": \"2026-11-13T09:04:05.253Z\",\n  \"metadata\": {\n    \"user_id\": 42\n  },\n  \"lang\": null,\n  \"region\": null,\n  \"payment_urls\": {\n    \"ru\": \"https://pay-shop.ru/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n    \"global\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\"\n  },\n  \"buyer_country\": null,\n  \"p2p_methods\": null,\n  \"p2p_currency\": \"convert\",\n  \"crypto_off\": false,\n  \"theme\": null,\n  \"customer\": {\n    \"name\": null,\n    \"company\": \"Acme GmbH\",\n    \"tax_id\": \"DE123456789\",\n    \"address\": null,\n    \"email\": \"billing@acme.example\"\n  },\n  \"documents\": {\n    \"invoice_url\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a/invoice\",\n    \"receipt_url\": null\n  },\n  \"status\": \"pending\",\n  \"is_final\": false,\n  \"network\": null,\n  \"network_name\": null,\n  \"token_standard\": null,\n  \"asset\": null,\n  \"symbol\": null,\n  \"pay_amount\": null,\n  \"paid_amount\": \"0\",\n  \"pending_amount\": \"0\",\n  \"remaining_amount\": null,\n  \"address\": null,\n  \"memo\": null,\n  \"payment_uri\": null,\n  \"required_confirmations\": null,\n  \"fee_level\": null,\n  \"settle_sec\": null,\n  \"rate_usd\": null,\n  \"paid_at\": null,\n  \"payments\": [],\n  \"refunded_amount\": \"0\",\n  \"refunds\": []\n}"}]},{"name":"Retrieve an invoice","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/invoices/:id","host":["{{baseUrl}}"],"path":["v1","invoices",":id"],"variable":[{"key":"id","value":"","description":"Invoice ID."}]},"description":"Current state of the invoice with all its payments.\n\n**Path parameters**\n\n- `id` (string, required) — Invoice ID.\n\n**Errors:** `not_found`\n\nDocumentation: https://paymway.com/en/docs#get-invoice"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/invoices/:id","host":["{{baseUrl}}"],"path":["v1","invoices",":id"],"variable":[{"key":"id","value":"","description":"Invoice ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n  \"order_id\": \"1001\",\n  \"amount\": \"49.9\",\n  \"currency\": \"EUR\",\n  \"amount_usd\": \"55.24\",\n  \"description\": \"Payment for order 1001\",\n  \"currency_is_fiat\": true,\n  \"payment_url\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n  \"url_success\": \"https://shop.example/thanks\",\n  \"url_return\": null,\n  \"expires_at\": \"2026-11-13T10:04:05.253Z\",\n  \"created_at\": \"2026-11-13T09:04:05.253Z\",\n  \"metadata\": {\n    \"user_id\": 42\n  },\n  \"lang\": null,\n  \"region\": null,\n  \"payment_urls\": {\n    \"ru\": \"https://pay-shop.ru/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n    \"global\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\"\n  },\n  \"buyer_country\": null,\n  \"p2p_methods\": null,\n  \"p2p_currency\": \"convert\",\n  \"crypto_off\": false,\n  \"theme\": null,\n  \"customer\": {\n    \"name\": null,\n    \"company\": \"Acme GmbH\",\n    \"tax_id\": \"DE123456789\",\n    \"address\": null,\n    \"email\": \"billing@acme.example\"\n  },\n  \"documents\": {\n    \"invoice_url\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a/invoice\",\n    \"receipt_url\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a/receipt\"\n  },\n  \"status\": \"paid\",\n  \"is_final\": true,\n  \"network\": \"tron\",\n  \"network_name\": \"TRON\",\n  \"token_standard\": \"TRC-20\",\n  \"asset\": \"tron:USDT\",\n  \"symbol\": \"USDT\",\n  \"pay_amount\": \"55.24\",\n  \"paid_amount\": \"55.24\",\n  \"pending_amount\": \"0\",\n  \"remaining_amount\": \"0\",\n  \"address\": \"TTRfafDmUho6qSvPUxJ5c8aq7Rp121Ukat\",\n  \"memo\": null,\n  \"payment_uri\": \"TTRfafDmUho6qSvPUxJ5c8aq7Rp121Ukat\",\n  \"required_confirmations\": 19,\n  \"fee_level\": \"medium\",\n  \"settle_sec\": 57,\n  \"rate_usd\": \"1\",\n  \"paid_at\": \"2026-11-13T09:05:28.416Z\",\n  \"payments\": [\n    {\n      \"id\": \"82a1a806-9162-4a3f-9109-e927ed7d6206\",\n      \"network\": \"tron\",\n      \"network_name\": \"TRON\",\n      \"asset\": \"tron:USDT\",\n      \"currency\": \"USDT\",\n      \"amount\": \"55.24\",\n      \"tx_hash\": \"b1f3c8a95e0d4a7c9e2f6b3d1a8c7e5f4b2d9a6c3e1f8b7a5d4c2e9f6b3a1d8c\",\n      \"from\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n      \"confirmations\": 19,\n      \"required_confirmations\": 19,\n      \"status\": \"confirmed\",\n      \"kind\": \"invoice\",\n      \"fee\": \"0.5524\",\n      \"credited_amount\": \"54.6876\",\n      \"explorer_url\": \"https://tronscan.org/#/transaction/b1f3c8a95e0d4a7c9e2f6b3d1a8c7e5f4b2d9a6c3e1f8b7a5d4c2e9f6b3a1d8c\",\n      \"detected_at\": \"2026-11-13T09:04:31.112Z\",\n      \"confirmed_at\": \"2026-11-13T09:05:28.416Z\"\n    }\n  ],\n  \"refunded_amount\": \"0\",\n  \"refunds\": []\n}"}]},{"name":"List invoices","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/invoices?order_id=1001","host":["{{baseUrl}}"],"path":["v1","invoices"],"query":[{"key":"order_id","value":"1001","description":"Find an invoice by your order number."},{"key":"status","value":"","description":"Filter by status.","disabled":true},{"key":"limit","value":"","description":"1 to 100, default 20.","disabled":true}]},"description":"Invoices, newest first. Handy for looking up an invoice by your order number.\n\n**Query parameters**\n\n- `order_id` (string) — Find an invoice by your order number.\n- `status` (string) — Filter by status.\n- `limit` (integer) — 1 to 100, default 20.\n\nDocumentation: https://paymway.com/en/docs#list-invoices"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/invoices?order_id=1001","host":["{{baseUrl}}"],"path":["v1","invoices"],"query":[{"key":"order_id","value":"1001","description":"Find an invoice by your order number."},{"key":"status","value":"","description":"Filter by status.","disabled":true},{"key":"limit","value":"","description":"1 to 100, default 20.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"items\": [\n    {\n      \"id\": \"6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n      \"order_id\": \"1001\",\n      \"amount\": \"49.9\",\n      \"currency\": \"EUR\",\n      \"amount_usd\": \"55.24\",\n      \"description\": \"Payment for order 1001\",\n      \"currency_is_fiat\": true,\n      \"payment_url\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n      \"url_success\": \"https://shop.example/thanks\",\n      \"url_return\": null,\n      \"expires_at\": \"2026-11-13T10:04:05.253Z\",\n      \"created_at\": \"2026-11-13T09:04:05.253Z\",\n      \"metadata\": {\n        \"user_id\": 42\n      },\n      \"lang\": null,\n      \"region\": null,\n      \"payment_urls\": {\n        \"ru\": \"https://pay-shop.ru/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n        \"global\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\"\n      },\n      \"buyer_country\": null,\n      \"p2p_methods\": null,\n      \"p2p_currency\": \"convert\",\n      \"crypto_off\": false,\n      \"theme\": null,\n      \"customer\": {\n        \"name\": null,\n        \"company\": \"Acme GmbH\",\n        \"tax_id\": \"DE123456789\",\n        \"address\": null,\n        \"email\": \"billing@acme.example\"\n      },\n      \"documents\": {\n        \"invoice_url\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a/invoice\",\n        \"receipt_url\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a/receipt\"\n      },\n      \"status\": \"paid\",\n      \"is_final\": true,\n      \"network\": \"tron\",\n      \"network_name\": \"TRON\",\n      \"token_standard\": \"TRC-20\",\n      \"asset\": \"tron:USDT\",\n      \"symbol\": \"USDT\",\n      \"pay_amount\": \"55.24\",\n      \"paid_amount\": \"55.24\",\n      \"pending_amount\": \"0\",\n      \"remaining_amount\": \"0\",\n      \"address\": \"TTRfafDmUho6qSvPUxJ5c8aq7Rp121Ukat\",\n      \"memo\": null,\n      \"payment_uri\": \"TTRfafDmUho6qSvPUxJ5c8aq7Rp121Ukat\",\n      \"required_confirmations\": 19,\n      \"fee_level\": \"medium\",\n      \"settle_sec\": 57,\n      \"rate_usd\": \"1\",\n      \"paid_at\": \"2026-11-13T09:05:28.416Z\",\n      \"payments\": [\n        {\n          \"id\": \"82a1a806-9162-4a3f-9109-e927ed7d6206\",\n          \"network\": \"tron\",\n          \"network_name\": \"TRON\",\n          \"asset\": \"tron:USDT\",\n          \"currency\": \"USDT\",\n          \"amount\": \"55.24\",\n          \"tx_hash\": \"b1f3c8a95e0d4a7c9e2f6b3d1a8c7e5f4b2d9a6c3e1f8b7a5d4c2e9f6b3a1d8c\",\n          \"from\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n          \"confirmations\": 19,\n          \"required_confirmations\": 19,\n          \"status\": \"confirmed\",\n          \"kind\": \"invoice\",\n          \"fee\": \"0.5524\",\n          \"credited_amount\": \"54.6876\",\n          \"explorer_url\": \"https://tronscan.org/#/transaction/b1f3c8a95e0d4a7c9e2f6b3d1a8c7e5f4b2d9a6c3e1f8b7a5d4c2e9f6b3a1d8c\",\n          \"detected_at\": \"2026-11-13T09:04:31.112Z\",\n          \"confirmed_at\": \"2026-11-13T09:05:28.416Z\"\n        }\n      ],\n      \"refunded_amount\": \"0\",\n      \"refunds\": []\n    }\n  ]\n}"}]},{"name":"Cancel an invoice","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/invoices/:id/cancel","host":["{{baseUrl}}"],"path":["v1","invoices",":id","cancel"],"variable":[{"key":"id","value":"","description":"Invoice ID."}]},"description":"Cancels a `pending` invoice that has not received any payments yet.\n\n**Path parameters**\n\n- `id` (string, required) — Invoice ID.\n\n**Errors:** `not_found`, `invoice_locked`\n\nDocumentation: https://paymway.com/en/docs#cancel-invoice"},"response":[{"name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/invoices/:id/cancel","host":["{{baseUrl}}"],"path":["v1","invoices",":id","cancel"],"variable":[{"key":"id","value":"","description":"Invoice ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n  \"order_id\": \"1001\",\n  \"amount\": \"49.9\",\n  \"currency\": \"EUR\",\n  \"amount_usd\": \"55.24\",\n  \"description\": \"Payment for order 1001\",\n  \"currency_is_fiat\": true,\n  \"payment_url\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n  \"url_success\": \"https://shop.example/thanks\",\n  \"url_return\": null,\n  \"expires_at\": \"2026-11-13T10:04:05.253Z\",\n  \"created_at\": \"2026-11-13T09:04:05.253Z\",\n  \"metadata\": {\n    \"user_id\": 42\n  },\n  \"lang\": null,\n  \"region\": null,\n  \"payment_urls\": {\n    \"ru\": \"https://pay-shop.ru/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n    \"global\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\"\n  },\n  \"buyer_country\": null,\n  \"p2p_methods\": null,\n  \"p2p_currency\": \"convert\",\n  \"crypto_off\": false,\n  \"theme\": null,\n  \"customer\": {\n    \"name\": null,\n    \"company\": \"Acme GmbH\",\n    \"tax_id\": \"DE123456789\",\n    \"address\": null,\n    \"email\": \"billing@acme.example\"\n  },\n  \"documents\": {\n    \"invoice_url\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a/invoice\",\n    \"receipt_url\": null\n  },\n  \"status\": \"cancelled\",\n  \"is_final\": true,\n  \"network\": null,\n  \"network_name\": null,\n  \"token_standard\": null,\n  \"asset\": null,\n  \"symbol\": null,\n  \"pay_amount\": null,\n  \"paid_amount\": \"0\",\n  \"pending_amount\": \"0\",\n  \"remaining_amount\": null,\n  \"address\": null,\n  \"memo\": null,\n  \"payment_uri\": null,\n  \"required_confirmations\": null,\n  \"fee_level\": null,\n  \"settle_sec\": null,\n  \"rate_usd\": null,\n  \"paid_at\": null,\n  \"payments\": [],\n  \"refunded_amount\": \"0\",\n  \"refunds\": []\n}"}]},{"name":"Refund the customer","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/invoices/:id/refund","host":["{{baseUrl}}"],"path":["v1","invoices",":id","refund"],"variable":[{"key":"id","value":"","description":"Invoice ID."}]},"body":{"mode":"raw","raw":"{\n  \"address\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n  \"reason\": \"Out of stock\"\n}","options":{"raw":{"language":"json"}}},"description":"Creates a refund for a paid invoice — a payout in the same coin and network the customer paid with. You can refund the full amount or part of it; several partial refunds are allowed as long as their total does not exceed the amount received. The refund amount and the network fee for sending it are debited from your balance; the service fee for receiving the payment is not refunded. From then on the refund is processed like a regular payout (large ones after review), and status updates arrive as `refund.*` webhooks. We recommend sending the `Idempotency-Key` header (see “Idempotency”): then retrying the request after a network error does not create a second refund, even without `order_id`.\n\n**Path parameters**\n\n- `id` (string, required) — Invoice ID.\n\n**Request body**\n\n- `address` (string, required) — Customer address on the invoice network. Ask the customer for it: the sender address on the blockchain often belongs to an exchange, and funds sent there will not reach the customer.\n- `amount` (string) — Amount in the invoice coin. Defaults to everything not yet refunded.\n- `memo` (string) — Transfer comment — needed when refunding to an exchange on TON.\n- `reason` (string) — Refund reason — for your records.\n- `order_id` (string) — Your refund ID. Repeating the request with it returns the same refund.\n- `url_callback` (string) — Webhook URL for this refund.\n\n**Errors:** `not_found`, `nothing_to_refund`, `refund_too_large`, `invalid_address`, `amount_too_small`, `insufficient_balance`\n\nDocumentation: https://paymway.com/en/docs#refund-invoice"},"response":[{"name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/invoices/:id/refund","host":["{{baseUrl}}"],"path":["v1","invoices",":id","refund"],"variable":[{"key":"id","value":"","description":"Invoice ID."}]},"body":{"mode":"raw","raw":"{\n  \"address\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n  \"reason\": \"Out of stock\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"c3b1e0a2-5d4f-4e8a-9b7c-1f2e3d4c5b6a\",\n  \"kind\": \"refund\",\n  \"invoice_id\": \"6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n  \"batch_id\": null,\n  \"reason\": \"Out of stock\",\n  \"order_id\": \"refund-1001-k3x9qa\",\n  \"status\": \"queued\",\n  \"network\": \"tron\",\n  \"network_name\": \"TRON\",\n  \"asset\": \"tron:USDT\",\n  \"currency\": \"USDT\",\n  \"address\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n  \"memo\": null,\n  \"amount\": \"55.24\",\n  \"fee\": \"2\",\n  \"total_debited\": \"57.24\",\n  \"tx_hash\": null,\n  \"explorer_url\": null,\n  \"error\": null,\n  \"created_at\": \"2026-11-13T09:04:05.395Z\",\n  \"completed_at\": null\n}"}]}]},{"name":"Static addresses","description":"A static address is assigned to a user of your service: every deposit to it is credited to your balance and reported with a `payment.confirmed` webhook with `kind: \"static\"` and your `order_id`. Ideal for balance top-ups in games, services and wallets — no invoices needed.","item":[{"name":"Get a static address","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/static-wallets","host":["{{baseUrl}}"],"path":["v1","static-wallets"]},"body":{"mode":"raw","raw":"{\n  \"network\": \"tron\",\n  \"order_id\": \"user-42\"\n}","options":{"raw":{"language":"json"}}},"description":"Returns the user’s address on the network. Calling again with the same `order_id` and network returns the same address.\n\n**Request body**\n\n- `network` (string, required) — Network ID: `tron`, `bsc`, `ethereum`, `solana`, `ton`…\n- `order_id` (string, required) — Your user ID.\n- `url_callback` (string) — Webhook URL for this address.\n\n**Errors:** `network_unavailable`\n\nDocumentation: https://paymway.com/en/docs#create-static-wallet"},"response":[{"name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/static-wallets","host":["{{baseUrl}}"],"path":["v1","static-wallets"]},"body":{"mode":"raw","raw":"{\n  \"network\": \"tron\",\n  \"order_id\": \"user-42\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"d20a74ce-7eab-4e3b-9258-8b0ce17807ac\",\n  \"order_id\": \"user-42\",\n  \"network\": \"tron\",\n  \"network_name\": \"TRON\",\n  \"assets\": [\n    \"TRX\",\n    \"USDT\"\n  ],\n  \"address\": \"THVC1jg4h9qkbU7STd1PGsrWzfXCJ5Z4es\",\n  \"memo\": null,\n  \"created_at\": \"2026-11-13T09:04:05.353Z\"\n}"}]}]},{"name":"Payments","description":"All incoming transfers to your addresses: invoice payments, static address deposits, late and “unexpected” payments.","item":[{"name":"List payments","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/payments","host":["{{baseUrl}}"],"path":["v1","payments"],"query":[{"key":"kind","value":"","description":"Filter: `invoice`, `static`, `unexpected`, `late`.","disabled":true},{"key":"limit","value":"","description":"1 to 100, default 50.","disabled":true}]},"description":"Payments, newest first. In addition to the Payment fields, each item contains `invoice_id` and `static_wallet_id`.\n\n**Query parameters**\n\n- `kind` (string) — Filter: `invoice`, `static`, `unexpected`, `late`.\n- `limit` (integer) — 1 to 100, default 50.\n\nDocumentation: https://paymway.com/en/docs#list-payments"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/payments","host":["{{baseUrl}}"],"path":["v1","payments"],"query":[{"key":"kind","value":"","description":"Filter: `invoice`, `static`, `unexpected`, `late`.","disabled":true},{"key":"limit","value":"","description":"1 to 100, default 50.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"items\": [\n    {\n      \"id\": \"82a1a806-9162-4a3f-9109-e927ed7d6206\",\n      \"network\": \"tron\",\n      \"network_name\": \"TRON\",\n      \"asset\": \"tron:USDT\",\n      \"currency\": \"USDT\",\n      \"amount\": \"55.24\",\n      \"tx_hash\": \"b1f3c8a95e0d4a7c9e2f6b3d1a8c7e5f4b2d9a6c3e1f8b7a5d4c2e9f6b3a1d8c\",\n      \"from\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n      \"confirmations\": 19,\n      \"required_confirmations\": 19,\n      \"status\": \"confirmed\",\n      \"kind\": \"invoice\",\n      \"fee\": \"0.5524\",\n      \"credited_amount\": \"54.6876\",\n      \"explorer_url\": \"https://tronscan.org/#/transaction/b1f3c8a95e0d4a7c9e2f6b3d1a8c7e5f4b2d9a6c3e1f8b7a5d4c2e9f6b3a1d8c\",\n      \"detected_at\": \"2026-11-13T09:04:31.112Z\",\n      \"confirmed_at\": \"2026-11-13T09:05:28.416Z\",\n      \"invoice_id\": \"6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n      \"static_wallet_id\": null\n    }\n  ]\n}"}]}]},{"name":"Balances","description":"Balances are kept per coin: USDT received on different networks adds up. You can withdraw it on any supported network.","item":[{"name":"Get balances","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/balances","host":["{{baseUrl}}"],"path":["v1","balances"]},"description":"Amounts available for withdrawal, per coin.\n\nDocumentation: https://paymway.com/en/docs#get-balances"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/balances","host":["{{baseUrl}}"],"path":["v1","balances"]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"items\": [\n    {\n      \"currency\": \"USDT\",\n      \"available\": \"1254.18\"\n    },\n    {\n      \"currency\": \"BTC\",\n      \"available\": \"0.01832\"\n    }\n  ]\n}"}]}]},{"name":"Payouts","description":"A payout transfers funds from your balance to an external address. The amount and fee are debited from the balance as soon as the payout is created; if the payout is rejected or fails, the funds are returned.\n\npending_approval → queued → processing → completed\n\nSmall payouts are sent automatically, large ones after manual review. The fee and minimum amount for each network are in `GET /v1/assets`.","item":[{"name":"Create a payout","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/payouts","host":["{{baseUrl}}"],"path":["v1","payouts"]},"body":{"mode":"raw","raw":"{\n  \"network\": \"tron\",\n  \"currency\": \"USDT\",\n  \"address\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n  \"amount\": \"150\",\n  \"order_id\": \"withdraw-77\"\n}","options":{"raw":{"language":"json"}}},"description":"Queues a payout. Repeating with the same `order_id` returns the existing payout. We also recommend sending the `Idempotency-Key` header (see “Idempotency”): a retry after a network error or a timeout returns the same response and debits nothing again.\n\n**Request body**\n\n- `network` (string, required) — Network ID, e.g. `tron`.\n- `currency` (string, required) — Coin ticker, e.g. `USDT`.\n- `address` (string, required) — Recipient address on this network — the format is validated.\n- `amount` (string, required) — Amount the recipient receives (the fee is added on top).\n- `order_id` (string, required) — Your unique payout ID.\n- `memo` (string) — Comment — required when withdrawing to an exchange on TON.\n- `url_callback` (string) — Webhook URL for this payout.\n\n**Errors:** `invalid_address`, `amount_too_small`, `insufficient_balance`, `order_exists`, `network_unavailable`\n\nDocumentation: https://paymway.com/en/docs#create-payout"},"response":[{"name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/payouts","host":["{{baseUrl}}"],"path":["v1","payouts"]},"body":{"mode":"raw","raw":"{\n  \"network\": \"tron\",\n  \"currency\": \"USDT\",\n  \"address\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n  \"amount\": \"150\",\n  \"order_id\": \"withdraw-77\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"41a6f86e-263f-4c35-bf06-f94ad715e04b\",\n  \"kind\": \"payout\",\n  \"invoice_id\": null,\n  \"batch_id\": null,\n  \"reason\": null,\n  \"order_id\": \"withdraw-77\",\n  \"status\": \"queued\",\n  \"network\": \"tron\",\n  \"network_name\": \"TRON\",\n  \"asset\": \"tron:USDT\",\n  \"currency\": \"USDT\",\n  \"address\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n  \"memo\": null,\n  \"amount\": \"150\",\n  \"fee\": \"2\",\n  \"total_debited\": \"152\",\n  \"tx_hash\": null,\n  \"explorer_url\": null,\n  \"error\": null,\n  \"created_at\": \"2026-11-13T09:04:05.395Z\",\n  \"completed_at\": null\n}"}]},{"name":"Batch payout","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/payouts/batch","host":["{{baseUrl}}"],"path":["v1","payouts","batch"]},"body":{"mode":"raw","raw":"{\n  \"reference\": \"salary-2026-11\",\n  \"items\": [\n    {\n      \"network\": \"tron\",\n      \"currency\": \"USDT\",\n      \"address\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n      \"amount\": \"250\"\n    },\n    {\n      \"network\": \"bsc\",\n      \"currency\": \"USDT\",\n      \"address\": \"0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed\",\n      \"amount\": \"180\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}},"description":"Up to 500 payouts in one request — salaries, affiliate payouts, winnings. Every row is validated first, and the balance is checked for each coin; either all payouts are created or none (`400 batch_invalid`, per-row results in `details`). With `validate_only: true` the request only validates. After that, each payout behaves like a regular one: above the daily limit it waits for approval. Repeating with the same `reference` returns the same batch; without `reference`, the `Idempotency-Key` header protects against duplicates (we recommend always sending it).\n\n**Request body**\n\n- `items` (object[], required) — Payouts: `network`, `currency`, `address`, `amount`, optionally `memo` and `order_id` (defaults to `<reference>-<number>`).\n- `reference` (string) — Your batch ID for idempotency.\n- `validate_only` (boolean) — Validate only, without creating anything: the response is `200 {valid, count, errors, rows, totals}` — per-row results and per-coin totals against your balance.\n- `url_callback` (string) — Webhook URL for the `payout.*` events of the batch payouts.\n\n**Errors:** `batch_invalid`, `batch_too_large`, `batch_empty`, `address_not_whitelisted`\n\nDocumentation: https://paymway.com/en/docs#create-payout-batch"},"response":[{"name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/payouts/batch","host":["{{baseUrl}}"],"path":["v1","payouts","batch"]},"body":{"mode":"raw","raw":"{\n  \"reference\": \"salary-2026-11\",\n  \"items\": [\n    {\n      \"network\": \"tron\",\n      \"currency\": \"USDT\",\n      \"address\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n      \"amount\": \"250\"\n    },\n    {\n      \"network\": \"bsc\",\n      \"currency\": \"USDT\",\n      \"address\": \"0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed\",\n      \"amount\": \"180\"\n    }\n  ]\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"batch\": {\n    \"id\": \"b1c2d3e4-0000-4000-8000-000000000001\",\n    \"reference\": \"salary-2026-11\",\n    \"source\": \"api\",\n    \"count\": 2,\n    \"totals\": {\n      \"USDT\": {\n        \"amount\": \"430\",\n        \"fee\": \"3\"\n      }\n    },\n    \"statuses\": {\n      \"queued\": 2\n    },\n    \"created_at\": \"2026-11-13T09:04:05.395Z\"\n  },\n  \"items\": [\n    {\n      \"id\": \"41a6f86e-263f-4c35-bf06-f94ad715e04b\",\n      \"kind\": \"payout\",\n      \"invoice_id\": null,\n      \"batch_id\": \"b1c2d3e4-0000-4000-8000-000000000001\",\n      \"reason\": null,\n      \"order_id\": \"salary-2026-11-1\",\n      \"status\": \"queued\",\n      \"network\": \"tron\",\n      \"network_name\": \"TRON\",\n      \"asset\": \"tron:USDT\",\n      \"currency\": \"USDT\",\n      \"address\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n      \"memo\": null,\n      \"amount\": \"250\",\n      \"fee\": \"2\",\n      \"total_debited\": \"152\",\n      \"tx_hash\": null,\n      \"explorer_url\": null,\n      \"error\": null,\n      \"created_at\": \"2026-11-13T09:04:05.395Z\",\n      \"completed_at\": null\n    }\n  ]\n}"}]},{"name":"Retrieve a payout batch","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/payouts/batch/:id","host":["{{baseUrl}}"],"path":["v1","payouts","batch",":id"],"variable":[{"key":"id","value":"","description":"Batch ID."}]},"description":"Batch totals and the current status of every payout in it.\n\n**Path parameters**\n\n- `id` (string, required) — Batch ID.\n\n**Errors:** `not_found`\n\nDocumentation: https://paymway.com/en/docs#get-payout-batch"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/payouts/batch/:id","host":["{{baseUrl}}"],"path":["v1","payouts","batch",":id"],"variable":[{"key":"id","value":"","description":"Batch ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"batch\": {\n    \"id\": \"b1c2d3e4-0000-4000-8000-000000000001\",\n    \"reference\": \"salary-2026-11\",\n    \"source\": \"api\",\n    \"count\": 2,\n    \"totals\": {\n      \"USDT\": {\n        \"amount\": \"430\",\n        \"fee\": \"3\"\n      }\n    },\n    \"statuses\": {\n      \"completed\": 1,\n      \"queued\": 1\n    },\n    \"created_at\": \"2026-11-13T09:04:05.395Z\"\n  },\n  \"items\": [\n    {\n      \"id\": \"41a6f86e-263f-4c35-bf06-f94ad715e04b\",\n      \"kind\": \"payout\",\n      \"invoice_id\": null,\n      \"batch_id\": \"b1c2d3e4-0000-4000-8000-000000000001\",\n      \"reason\": null,\n      \"order_id\": \"salary-2026-11-1\",\n      \"status\": \"queued\",\n      \"network\": \"tron\",\n      \"network_name\": \"TRON\",\n      \"asset\": \"tron:USDT\",\n      \"currency\": \"USDT\",\n      \"address\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n      \"memo\": null,\n      \"amount\": \"250\",\n      \"fee\": \"2\",\n      \"total_debited\": \"152\",\n      \"tx_hash\": null,\n      \"explorer_url\": null,\n      \"error\": null,\n      \"created_at\": \"2026-11-13T09:04:05.395Z\",\n      \"completed_at\": null\n    }\n  ]\n}"}]},{"name":"Retrieve a payout","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/payouts/:id","host":["{{baseUrl}}"],"path":["v1","payouts",":id"],"variable":[{"key":"id","value":"","description":"Payout ID."}]},"description":"Current payout status and transaction hash.\n\n**Path parameters**\n\n- `id` (string, required) — Payout ID.\n\n**Errors:** `not_found`\n\nDocumentation: https://paymway.com/en/docs#get-payout"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/payouts/:id","host":["{{baseUrl}}"],"path":["v1","payouts",":id"],"variable":[{"key":"id","value":"","description":"Payout ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"41a6f86e-263f-4c35-bf06-f94ad715e04b\",\n  \"kind\": \"payout\",\n  \"invoice_id\": null,\n  \"batch_id\": null,\n  \"reason\": null,\n  \"order_id\": \"withdraw-77\",\n  \"status\": \"completed\",\n  \"network\": \"tron\",\n  \"network_name\": \"TRON\",\n  \"asset\": \"tron:USDT\",\n  \"currency\": \"USDT\",\n  \"address\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n  \"memo\": null,\n  \"amount\": \"150\",\n  \"fee\": \"2\",\n  \"total_debited\": \"152\",\n  \"tx_hash\": \"7c0de4b1a9f2e8d3c6b5a4f7e2d1c9b8a6f5e4d3c2b1a0f9e8d7c6b5a4f3e2d1\",\n  \"explorer_url\": \"https://tronscan.org/#/transaction/7c0de4b1a9f2e8d3c6b5a4f7e2d1c9b8a6f5e4d3c2b1a0f9e8d7c6b5a4f3e2d1\",\n  \"error\": null,\n  \"created_at\": \"2026-11-13T09:04:05.395Z\",\n  \"completed_at\": \"2026-11-13T09:06:12.004Z\"\n}"}]},{"name":"List payouts","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/payouts","host":["{{baseUrl}}"],"path":["v1","payouts"],"query":[{"key":"order_id","value":"","description":"Find a payout by your ID.","disabled":true},{"key":"status","value":"","description":"Filter by status.","disabled":true},{"key":"limit","value":"","description":"1 to 100, default 50.","disabled":true}]},"description":"Payouts, newest first.\n\n**Query parameters**\n\n- `order_id` (string) — Find a payout by your ID.\n- `status` (string) — Filter by status.\n- `limit` (integer) — 1 to 100, default 50.\n\nDocumentation: https://paymway.com/en/docs#list-payouts"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/payouts","host":["{{baseUrl}}"],"path":["v1","payouts"],"query":[{"key":"order_id","value":"","description":"Find a payout by your ID.","disabled":true},{"key":"status","value":"","description":"Filter by status.","disabled":true},{"key":"limit","value":"","description":"1 to 100, default 50.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"items\": [\n    {\n      \"id\": \"41a6f86e-263f-4c35-bf06-f94ad715e04b\",\n      \"kind\": \"payout\",\n      \"invoice_id\": null,\n      \"batch_id\": null,\n      \"reason\": null,\n      \"order_id\": \"withdraw-77\",\n      \"status\": \"queued\",\n      \"network\": \"tron\",\n      \"network_name\": \"TRON\",\n      \"asset\": \"tron:USDT\",\n      \"currency\": \"USDT\",\n      \"address\": \"TPyjyZfsYaXStgz2NmAraF1uZcMtkgNan5\",\n      \"memo\": null,\n      \"amount\": \"150\",\n      \"fee\": \"2\",\n      \"total_debited\": \"152\",\n      \"tx_hash\": null,\n      \"explorer_url\": null,\n      \"error\": null,\n      \"created_at\": \"2026-11-13T09:04:05.395Z\",\n      \"completed_at\": null\n    }\n  ]\n}"}]}]},{"name":"Coins and networks","description":"Supported assets and their parameters: confirmations, minimum amounts, withdrawal fees, current rates. The table below shows the service’s live data.","item":[{"name":"List assets","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/assets","host":["{{baseUrl}}"],"path":["v1","assets"]},"description":"All assets currently available for payments and withdrawals.\n\nDocumentation: https://paymway.com/en/docs#list-assets"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/assets","host":["{{baseUrl}}"],"path":["v1","assets"]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"items\": [\n    {\n      \"id\": \"tron:USDT\",\n      \"symbol\": \"USDT\",\n      \"name\": \"Tether USD\",\n      \"network\": \"tron\",\n      \"network_name\": \"TRON\",\n      \"standard\": \"TRC-20\",\n      \"contract\": \"TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t\",\n      \"decimals\": 6,\n      \"confirmations\": 19,\n      \"min_amount\": \"0.01\",\n      \"rate_usd\": \"1\",\n      \"payable\": true,\n      \"payout_fee\": \"2\",\n      \"min_payout\": \"5\"\n    }\n  ]\n}"}]},{"name":"Current domains","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/domains","host":["{{baseUrl}}"],"path":["v1","domains"]},"auth":{"type":"noauth"},"description":"The service’s primary domain in each region: `ru` — for customers in Russia, `global` — for everyone else. If a domain gets blocked, the service switches to a backup one — this method always returns the current domain. No API key required.\n\n_No API key required._\n\nDocumentation: https://paymway.com/en/docs#list-domains"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/domains","host":["{{baseUrl}}"],"path":["v1","domains"]},"auth":{"type":"noauth"}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"regions\": {\n    \"ru\": {\n      \"active\": \"https://pay-shop.ru\"\n    },\n    \"global\": {\n      \"active\": \"https://paymway.com\"\n    }\n  },\n  \"fallback\": \"https://paymway.com\"\n}"}]},{"name":"Service status","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/status","host":["{{baseUrl}}"],"path":["v1","status"]},"auth":{"type":"noauth"},"description":"Whether the service is working right now: the API and payment page, payment crediting, webhooks, payouts and each network. `level`: `operational`, `degraded` (delays), `outage`, `maintenance`. Also lists open incidents and scheduled maintenance. Text fields (`text`, `name`, `level_text`, `status_text`) are for display — in Russian by default, in English with `Accept-Language: en`; base your logic on `level` and `id`. The human-readable version is the `/status` page, the incident feed is `/status/feed.atom`. No API key required.\n\n_No API key required._\n\nDocumentation: https://paymway.com/en/docs#get-status"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/status","host":["{{baseUrl}}"],"path":["v1","status"]},"auth":{"type":"noauth"}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"status\": {\n    \"level\": \"operational\",\n    \"text\": \"All systems operational\"\n  },\n  \"components\": [\n    {\n      \"id\": \"api\",\n      \"group\": \"service\",\n      \"name\": \"API and payment page\",\n      \"level\": \"operational\",\n      \"level_text\": \"Operational\"\n    },\n    {\n      \"id\": \"net:tron\",\n      \"group\": \"networks\",\n      \"name\": \"TRON\",\n      \"level\": \"operational\",\n      \"level_text\": \"Operational\"\n    }\n  ],\n  \"incidents\": {\n    \"active\": [],\n    \"scheduled\": [],\n    \"recent\": []\n  },\n  \"updated_at\": \"2026-11-13T09:04:05.000Z\"\n}"}]},{"name":"Invoice currencies","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/currencies","host":["{{baseUrl}}"],"path":["v1","currencies"]},"description":"Currencies you can set the invoice amount in (`currency` in `POST /v1/invoices`): fiat at the current rate and the coins of connected networks. For coins, the networks they can be received on are listed. Use `code` in requests; `name` is a display name (in English with `Accept-Language: en`).\n\nDocumentation: https://paymway.com/en/docs#list-currencies"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/currencies","host":["{{baseUrl}}"],"path":["v1","currencies"]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"items\": [\n    {\n      \"code\": \"USD\",\n      \"type\": \"fiat\",\n      \"name\": \"US Dollar\",\n      \"rate_usd\": \"1\",\n      \"networks\": []\n    },\n    {\n      \"code\": \"EUR\",\n      \"type\": \"fiat\",\n      \"name\": \"Euro\",\n      \"rate_usd\": \"1.1\",\n      \"networks\": []\n    },\n    {\n      \"code\": \"USDT\",\n      \"type\": \"crypto\",\n      \"name\": \"Tether USD\",\n      \"rate_usd\": \"1\",\n      \"networks\": [\n        \"tron\",\n        \"bsc\",\n        \"ethereum\",\n        \"solana\",\n        \"ton\"\n      ]\n    }\n  ]\n}"}]}]},{"name":"Recurring payments","description":"Subscriptions to your services: SaaS, online services, memberships. Cryptocurrency cannot be charged automatically, so a subscription is a schedule of invoices, reminders to the customer and statuses.\n\n- **Create a plan** — `POST /v1/plans`: amount and period, optionally a trial.\n- **Create a subscription** — `POST /v1/subscriptions` with the customer’s email. Without a trial, the invoice for the first period is issued immediately: send the customer to `current_invoice.payment_url`.\n- **The rest is automatic:** before the paid period ends (3 days ahead by default), the customer receives an invoice for the next period (by email and in Telegram), and a reminder one day before. Payment extends the subscription from the end of the current period, and you receive a `subscription.renewed` webhook.\n\npending / trialing → active → past_due → expired\n\n- Status — Meaning\n- `pending` — Awaiting the first payment. If none arrives before the grace period ends — `expired`\n- `trialing` — Trial period; the invoice for the first period arrives before it ends\n- `active` — Paid until `current_period_end` — **provide the service**\n- `past_due` — The period has ended and the invoice is unpaid. We wait `grace_days` days (3 by default) — it is up to you whether to keep providing the service\n- `cancelled` — Cancelled: by you, by the customer on the subscription page, or at the end of the period after renewal was cancelled\n- `expired` — Not paid before the grace period ended\n\n- A subscription invoice is a regular invoice: its `order_id` looks like `sub-<subscription id>-<period number>`, it carries `metadata.billing_subscription_id`, and it triggers the usual `invoice.*` webhooks. Funds are credited to your balance as usual.\n- Reminders to the customer: emails (in Russian or English, depending on `locale`) when a new invoice is issued, ahead of the due date (the number of days is a service setting), when the payment is overdue and when the subscription is stopped. On the subscription page (`customer_url`) the customer can turn on Telegram reminders.\n- Price and period are locked at signup: changes to a plan apply to new subscriptions only.\n- Monthly periods are counted from the original day: a subscription started on January 31 renews on February 28 (29), then on March 31.\n\n### Subscription webhooks\n\nSent to the webhook URL from the dashboard and signed like all other webhooks. `data` contains the Subscription object; invoice-related events also include `invoice` (same shape as `current_invoice`).\n\n- Event — When\n- `subscription.created` — Subscription created\n- `subscription.invoice_created` — Invoice for the next period issued (+ `invoice`)\n- `subscription.renewed` — **Invoice paid, period extended** (+ `invoice`)\n- `subscription.past_due` — The period has ended, the invoice is unpaid\n- `subscription.cancel_scheduled`, `subscription.resumed` — Renewal cancelled / resumed (the subscription stays active until the end of the period)\n- `subscription.cancelled` — Subscription cancelled\n- `subscription.expired` — Not paid before the grace period ended","item":[{"name":"Create a plan","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/plans","host":["{{baseUrl}}"],"path":["v1","plans"]},"body":{"mode":"raw","raw":"{\n  \"name\": \"Pro\",\n  \"amount\": \"29\",\n  \"currency\": \"USD\",\n  \"interval\": \"month\",\n  \"trial_days\": 14,\n  \"description\": \"Up to 10 projects and priority support\"\n}","options":{"raw":{"language":"json"}}},"description":"A plan defines the amount and the billing period. Subscriptions are created for a plan.\n\n**Request body**\n\n- `name` (string, required) — Name (up to 120 characters).\n- `amount` (string, required) — Amount per period, e.g. `\"29\"`.\n- `currency` (string, required) — Currency: `USD`, `EUR`, `RUB`, `UAH`, `KZT`, `GBP`, `TRY` or a coin ticker (`USDT`…).\n- `interval` (string, required) — `day`, `week`, `month` or `year`.\n- `interval_count` (integer) — Units per period, default 1. At most 365 days, 260 weeks, 60 months, 5 years.\n- `trial_days` (integer) — Trial period, days (0–365). Default 0.\n- `grace_days` (integer) — Grace period after the period ends, days (0–60). Default 3.\n- `allowed_assets` (string[]) — Restrict the payment coins, e.g. `[\"tron:USDT\",\"bsc:USDT\"]`.\n- `description` (string) — Description for the customer (up to 500 characters).\n\n**Errors:** `validation_error`, `unsupported_currency`, `invalid_interval`, `unknown_asset`\n\nDocumentation: https://paymway.com/en/docs#create-plan"},"response":[{"name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/plans","host":["{{baseUrl}}"],"path":["v1","plans"]},"body":{"mode":"raw","raw":"{\n  \"name\": \"Pro\",\n  \"amount\": \"29\",\n  \"currency\": \"USD\",\n  \"interval\": \"month\",\n  \"trial_days\": 14,\n  \"description\": \"Up to 10 projects and priority support\"\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"5d0c1b8e-2f4a-4c3b-9e7d-1a2b3c4d5e6f\",\n  \"name\": \"Pro\",\n  \"description\": \"Up to 10 projects and priority support\",\n  \"amount\": \"29\",\n  \"currency\": \"USD\",\n  \"interval\": \"month\",\n  \"interval_count\": 1,\n  \"trial_days\": 14,\n  \"grace_days\": 3,\n  \"allowed_assets\": null,\n  \"archived\": false,\n  \"archived_at\": null,\n  \"created_at\": \"2026-11-13T09:00:00.000Z\"\n}"}]},{"name":"List plans","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/plans","host":["{{baseUrl}}"],"path":["v1","plans"],"query":[{"key":"include_archived","value":"","description":"`true` — include archived plans.","disabled":true},{"key":"limit","value":"","description":"1 to 100, default 50.","disabled":true}]},"description":"Plans, newest first; archived plans last.\n\n**Query parameters**\n\n- `include_archived` (string) — `true` — include archived plans.\n- `limit` (integer) — 1 to 100, default 50.\n\nDocumentation: https://paymway.com/en/docs#list-plans"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/plans","host":["{{baseUrl}}"],"path":["v1","plans"],"query":[{"key":"include_archived","value":"","description":"`true` — include archived plans.","disabled":true},{"key":"limit","value":"","description":"1 to 100, default 50.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"items\": [\n    {\n      \"id\": \"5d0c1b8e-2f4a-4c3b-9e7d-1a2b3c4d5e6f\",\n      \"name\": \"Pro\",\n      \"description\": \"Up to 10 projects and priority support\",\n      \"amount\": \"29\",\n      \"currency\": \"USD\",\n      \"interval\": \"month\",\n      \"interval_count\": 1,\n      \"trial_days\": 14,\n      \"grace_days\": 3,\n      \"allowed_assets\": null,\n      \"archived\": false,\n      \"archived_at\": null,\n      \"created_at\": \"2026-11-13T09:00:00.000Z\"\n    }\n  ]\n}"}]},{"name":"Retrieve a plan","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/plans/:id","host":["{{baseUrl}}"],"path":["v1","plans",":id"],"variable":[{"key":"id","value":"","description":"Plan ID."}]},"description":"Plan by ID.\n\n**Path parameters**\n\n- `id` (string, required) — Plan ID.\n\n**Errors:** `not_found`\n\nDocumentation: https://paymway.com/en/docs#get-plan"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/plans/:id","host":["{{baseUrl}}"],"path":["v1","plans",":id"],"variable":[{"key":"id","value":"","description":"Plan ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"5d0c1b8e-2f4a-4c3b-9e7d-1a2b3c4d5e6f\",\n  \"name\": \"Pro\",\n  \"description\": \"Up to 10 projects and priority support\",\n  \"amount\": \"29\",\n  \"currency\": \"USD\",\n  \"interval\": \"month\",\n  \"interval_count\": 1,\n  \"trial_days\": 14,\n  \"grace_days\": 3,\n  \"allowed_assets\": null,\n  \"archived\": false,\n  \"archived_at\": null,\n  \"created_at\": \"2026-11-13T09:00:00.000Z\"\n}"}]},{"name":"Archive a plan","request":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/plans/:id/archive","host":["{{baseUrl}}"],"path":["v1","plans",":id","archive"],"variable":[{"key":"id","value":"","description":"Plan ID."}]},"description":"No new subscriptions to the plan can be created. Existing subscriptions continue on the same terms.\n\n**Path parameters**\n\n- `id` (string, required) — Plan ID.\n\n**Errors:** `not_found`\n\nDocumentation: https://paymway.com/en/docs#archive-plan"},"response":[{"name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/plans/:id/archive","host":["{{baseUrl}}"],"path":["v1","plans",":id","archive"],"variable":[{"key":"id","value":"","description":"Plan ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"5d0c1b8e-2f4a-4c3b-9e7d-1a2b3c4d5e6f\",\n  \"name\": \"Pro\",\n  \"description\": \"Up to 10 projects and priority support\",\n  \"amount\": \"29\",\n  \"currency\": \"USD\",\n  \"interval\": \"month\",\n  \"interval_count\": 1,\n  \"trial_days\": 14,\n  \"grace_days\": 3,\n  \"allowed_assets\": null,\n  \"archived\": true,\n  \"archived_at\": \"2026-12-01T10:00:00.000Z\",\n  \"created_at\": \"2026-11-13T09:00:00.000Z\"\n}"}]},{"name":"Create a subscription","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/subscriptions","host":["{{baseUrl}}"],"path":["v1","subscriptions"]},"body":{"mode":"raw","raw":"{\n  \"plan_id\": \"5d0c1b8e-2f4a-4c3b-9e7d-1a2b3c4d5e6f\",\n  \"customer\": {\n    \"email\": \"anna@example.com\",\n    \"name\": \"Anna\",\n    \"reference\": \"user-42\"\n  },\n  \"order_id\": \"user-42-pro\",\n  \"metadata\": {\n    \"user_id\": 42\n  }\n}","options":{"raw":{"language":"json"}}},"description":"Creates a subscription to a plan. Without a trial, the invoice for the first period is issued immediately — the payment link is in `current_invoice.payment_url`, and the customer also receives it by email. Repeating with the same `order_id` returns the existing subscription (response `200`).\n\n**Request body**\n\n- `plan_id` (string, required) — Plan ID.\n- `customer` (object) — Customer: `email` — where invoices and reminders are sent, `name`, `reference` — your user ID.\n- `order_id` (string) — Your unique subscription ID (up to 128 characters). Ensures idempotency.\n- `locale` (string) — Language of emails and the subscription page: `ru` (default) or `en`.\n- `start_at` (string) — Subscription start in the future (ISO 8601), at most one year ahead. Defaults to now.\n- `metadata` (object) — Arbitrary data — returned in responses and webhooks.\n\n**Errors:** `validation_error`, `plan_not_found`, `plan_archived`, `order_exists`, `invalid_start`\n\nDocumentation: https://paymway.com/en/docs#create-subscription"},"response":[{"name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/subscriptions","host":["{{baseUrl}}"],"path":["v1","subscriptions"]},"body":{"mode":"raw","raw":"{\n  \"plan_id\": \"5d0c1b8e-2f4a-4c3b-9e7d-1a2b3c4d5e6f\",\n  \"customer\": {\n    \"email\": \"anna@example.com\",\n    \"name\": \"Anna\",\n    \"reference\": \"user-42\"\n  },\n  \"order_id\": \"user-42-pro\",\n  \"metadata\": {\n    \"user_id\": 42\n  }\n}","options":{"raw":{"language":"json"}}}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"b7e4c2a1-9d3f-4e8b-a5c6-0f1e2d3c4b5a\",\n  \"status\": \"pending\",\n  \"plan_id\": \"5d0c1b8e-2f4a-4c3b-9e7d-1a2b3c4d5e6f\",\n  \"plan_name\": \"Pro\",\n  \"order_id\": \"user-42-pro\",\n  \"customer\": {\n    \"email\": \"anna@example.com\",\n    \"name\": \"Anna\",\n    \"reference\": \"user-42\"\n  },\n  \"locale\": \"ru\",\n  \"amount\": \"29\",\n  \"currency\": \"USD\",\n  \"interval\": \"month\",\n  \"interval_count\": 1,\n  \"trial_end\": null,\n  \"period_number\": 0,\n  \"current_period_start\": \"2026-11-13T09:00:00.000Z\",\n  \"current_period_end\": \"2026-11-13T09:00:00.000Z\",\n  \"next_payment_at\": \"2026-11-13T09:00:00.000Z\",\n  \"cancel_at_period_end\": false,\n  \"cancelled_at\": null,\n  \"ended_at\": null,\n  \"current_invoice\": {\n    \"id\": \"0e9f8a7b-6c5d-4e3f-8a1b-2c3d4e5f6a7b\",\n    \"status\": \"pending\",\n    \"period_number\": 1,\n    \"amount\": \"29\",\n    \"currency\": \"USD\",\n    \"due_at\": \"2026-11-13T09:00:00.000Z\",\n    \"expires_at\": \"2026-11-16T09:00:00.000Z\",\n    \"payment_url\": \"https://paymway.com/pay/0e9f8a7b-6c5d-4e3f-8a1b-2c3d4e5f6a7b\"\n  },\n  \"customer_url\": \"https://paymway.com/s/Xq3v9Lr2Tn8Wk5Pz1Hc7Jm4Ba6Ds0Fe\",\n  \"metadata\": {\n    \"user_id\": 42\n  },\n  \"created_at\": \"2026-11-13T09:00:00.000Z\"\n}"}]},{"name":"List subscriptions","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/subscriptions?customer_email=anna%40example.com","host":["{{baseUrl}}"],"path":["v1","subscriptions"],"query":[{"key":"status","value":"","description":"Filter by status.","disabled":true},{"key":"plan_id","value":"","description":"Subscriptions to one plan.","disabled":true},{"key":"order_id","value":"","description":"Find by your ID.","disabled":true},{"key":"customer_email","value":"anna@example.com","description":"A customer’s subscriptions by email."},{"key":"limit","value":"","description":"1 to 100, default 20.","disabled":true},{"key":"offset","value":"","description":"How many items to skip — for pagination.","disabled":true}]},"description":"Subscriptions, newest first.\n\n**Query parameters**\n\n- `status` (string) — Filter by status.\n- `plan_id` (string) — Subscriptions to one plan.\n- `order_id` (string) — Find by your ID.\n- `customer_email` (string) — A customer’s subscriptions by email.\n- `limit` (integer) — 1 to 100, default 20.\n- `offset` (integer) — How many items to skip — for pagination.\n\nDocumentation: https://paymway.com/en/docs#list-subscriptions"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/subscriptions?customer_email=anna%40example.com","host":["{{baseUrl}}"],"path":["v1","subscriptions"],"query":[{"key":"status","value":"","description":"Filter by status.","disabled":true},{"key":"plan_id","value":"","description":"Subscriptions to one plan.","disabled":true},{"key":"order_id","value":"","description":"Find by your ID.","disabled":true},{"key":"customer_email","value":"anna@example.com","description":"A customer’s subscriptions by email."},{"key":"limit","value":"","description":"1 to 100, default 20.","disabled":true},{"key":"offset","value":"","description":"How many items to skip — for pagination.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"items\": [\n    {\n      \"id\": \"b7e4c2a1-9d3f-4e8b-a5c6-0f1e2d3c4b5a\",\n      \"status\": \"active\",\n      \"plan_id\": \"5d0c1b8e-2f4a-4c3b-9e7d-1a2b3c4d5e6f\",\n      \"plan_name\": \"Pro\",\n      \"order_id\": \"user-42-pro\",\n      \"customer\": {\n        \"email\": \"anna@example.com\",\n        \"name\": \"Anna\",\n        \"reference\": \"user-42\"\n      },\n      \"locale\": \"ru\",\n      \"amount\": \"29\",\n      \"currency\": \"USD\",\n      \"interval\": \"month\",\n      \"interval_count\": 1,\n      \"trial_end\": \"2026-11-27T09:00:00.000Z\",\n      \"period_number\": 1,\n      \"current_period_start\": \"2026-11-27T09:00:00.000Z\",\n      \"current_period_end\": \"2026-12-27T09:00:00.000Z\",\n      \"next_payment_at\": \"2026-12-27T09:00:00.000Z\",\n      \"cancel_at_period_end\": false,\n      \"cancelled_at\": null,\n      \"ended_at\": null,\n      \"current_invoice\": {\n        \"id\": \"0e9f8a7b-6c5d-4e3f-8a1b-2c3d4e5f6a7b\",\n        \"status\": \"pending\",\n        \"period_number\": 2,\n        \"amount\": \"29\",\n        \"currency\": \"USD\",\n        \"due_at\": \"2026-12-27T09:00:00.000Z\",\n        \"expires_at\": \"2026-12-30T09:00:00.000Z\",\n        \"payment_url\": \"https://paymway.com/pay/0e9f8a7b-6c5d-4e3f-8a1b-2c3d4e5f6a7b\"\n      },\n      \"customer_url\": \"https://paymway.com/s/Xq3v9Lr2Tn8Wk5Pz1Hc7Jm4Ba6Ds0Fe\",\n      \"metadata\": {\n        \"user_id\": 42\n      },\n      \"created_at\": \"2026-11-13T09:00:00.000Z\"\n    }\n  ]\n}"}]},{"name":"Retrieve a subscription","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/subscriptions/:id","host":["{{baseUrl}}"],"path":["v1","subscriptions",":id"],"variable":[{"key":"id","value":"","description":"Subscription ID."}]},"description":"Current state of the subscription and the invoice for the next period.\n\n**Path parameters**\n\n- `id` (string, required) — Subscription ID.\n\n**Errors:** `not_found`\n\nDocumentation: https://paymway.com/en/docs#get-subscription"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/v1/subscriptions/:id","host":["{{baseUrl}}"],"path":["v1","subscriptions",":id"],"variable":[{"key":"id","value":"","description":"Subscription ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"b7e4c2a1-9d3f-4e8b-a5c6-0f1e2d3c4b5a\",\n  \"status\": \"active\",\n  \"plan_id\": \"5d0c1b8e-2f4a-4c3b-9e7d-1a2b3c4d5e6f\",\n  \"plan_name\": \"Pro\",\n  \"order_id\": \"user-42-pro\",\n  \"customer\": {\n    \"email\": \"anna@example.com\",\n    \"name\": \"Anna\",\n    \"reference\": \"user-42\"\n  },\n  \"locale\": \"ru\",\n  \"amount\": \"29\",\n  \"currency\": \"USD\",\n  \"interval\": \"month\",\n  \"interval_count\": 1,\n  \"trial_end\": \"2026-11-27T09:00:00.000Z\",\n  \"period_number\": 1,\n  \"current_period_start\": \"2026-11-27T09:00:00.000Z\",\n  \"current_period_end\": \"2026-12-27T09:00:00.000Z\",\n  \"next_payment_at\": \"2026-12-27T09:00:00.000Z\",\n  \"cancel_at_period_end\": false,\n  \"cancelled_at\": null,\n  \"ended_at\": null,\n  \"current_invoice\": {\n    \"id\": \"0e9f8a7b-6c5d-4e3f-8a1b-2c3d4e5f6a7b\",\n    \"status\": \"pending\",\n    \"period_number\": 2,\n    \"amount\": \"29\",\n    \"currency\": \"USD\",\n    \"due_at\": \"2026-12-27T09:00:00.000Z\",\n    \"expires_at\": \"2026-12-30T09:00:00.000Z\",\n    \"payment_url\": \"https://paymway.com/pay/0e9f8a7b-6c5d-4e3f-8a1b-2c3d4e5f6a7b\"\n  },\n  \"customer_url\": \"https://paymway.com/s/Xq3v9Lr2Tn8Wk5Pz1Hc7Jm4Ba6Ds0Fe\",\n  \"metadata\": {\n    \"user_id\": 42\n  },\n  \"created_at\": \"2026-11-13T09:00:00.000Z\"\n}"}]},{"name":"Cancel a subscription","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/subscriptions/:id/cancel","host":["{{baseUrl}}"],"path":["v1","subscriptions",":id","cancel"],"variable":[{"key":"id","value":"","description":"Subscription ID."}]},"body":{"mode":"raw","raw":"{\n  \"at_period_end\": true\n}","options":{"raw":{"language":"json"}}},"description":"Immediately (default) or at the end of the paid period. An unpaid invoice for the next period is cancelled. A subscription without a paid period (`pending`, `past_due`) is cancelled immediately. Repeating the call changes nothing.\n\n**Path parameters**\n\n- `id` (string, required) — Subscription ID.\n\n**Request body**\n\n- `at_period_end` (boolean) — `true` — cancel renewal: the subscription stays active until `current_period_end`, then becomes `cancelled`.\n\n**Errors:** `not_found`\n\nDocumentation: https://paymway.com/en/docs#cancel-subscription"},"response":[{"name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Idempotency key: enable it so that retrying the request after a failure does not process it twice (the saved response is returned with the Idempotent-Replayed: true header). {{$guid}} is a new key on every send; to retry the same operation, paste the key of the previous attempt. Kept for 24 hours.","disabled":true}],"url":{"raw":"{{baseUrl}}/v1/subscriptions/:id/cancel","host":["{{baseUrl}}"],"path":["v1","subscriptions",":id","cancel"],"variable":[{"key":"id","value":"","description":"Subscription ID."}]},"body":{"mode":"raw","raw":"{\n  \"at_period_end\": true\n}","options":{"raw":{"language":"json"}}}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"b7e4c2a1-9d3f-4e8b-a5c6-0f1e2d3c4b5a\",\n  \"status\": \"active\",\n  \"plan_id\": \"5d0c1b8e-2f4a-4c3b-9e7d-1a2b3c4d5e6f\",\n  \"plan_name\": \"Pro\",\n  \"order_id\": \"user-42-pro\",\n  \"customer\": {\n    \"email\": \"anna@example.com\",\n    \"name\": \"Anna\",\n    \"reference\": \"user-42\"\n  },\n  \"locale\": \"ru\",\n  \"amount\": \"29\",\n  \"currency\": \"USD\",\n  \"interval\": \"month\",\n  \"interval_count\": 1,\n  \"trial_end\": \"2026-11-27T09:00:00.000Z\",\n  \"period_number\": 1,\n  \"current_period_start\": \"2026-11-27T09:00:00.000Z\",\n  \"current_period_end\": \"2026-12-27T09:00:00.000Z\",\n  \"next_payment_at\": null,\n  \"cancel_at_period_end\": true,\n  \"cancelled_at\": \"2026-12-01T10:00:00.000Z\",\n  \"ended_at\": null,\n  \"current_invoice\": null,\n  \"customer_url\": \"https://paymway.com/s/Xq3v9Lr2Tn8Wk5Pz1Hc7Jm4Ba6Ds0Fe\",\n  \"metadata\": {\n    \"user_id\": 42\n  },\n  \"created_at\": \"2026-11-13T09:00:00.000Z\"\n}"}]}]},{"name":"Payment buttons and widget","description":"A payment button works like a Payment Link: create it in the dashboard (Payment buttons) and get a link `https://paymway.com/b/CODE` for social media and messengers, plus button code for any website. The amount is either fixed or entered by the customer (donations, top-ups, paying a bill) within a minimum and maximum. Every click creates a regular invoice with an `order_id` like `btn-CODE-…` — the payment shows up under “Invoices”, and your URL receives the same `invoice.*` webhooks. The customer’s email and comment are stored in the invoice `metadata`: `{\"button\": \"CODE\", \"email\": \"…\", \"comment\": \"…\"}`.\n\n### A button on your website — one line\n\n```\n<script src=\"https://paymway.com/widget.js\" data-button=\"CODE\" async></script>\n```\n\nThe button appears where the tag is placed. For several buttons on one page, use the markup `<div data-cp-button=\"CODE\"></div>` and a single `<script src=\"https://paymway.com/widget.js\" async></script>` tag at the end of the page (buttons added later by the site’s scripts appear too).\n\n- Attribute — Value\n- `data-theme` — `light` (default) or `dark` — for dark websites\n- `data-lang` — `ru` or `en`; defaults to the page language\n- `data-label` — Custom button text, e.g. “Support the project”\n\n- The button is rendered in Shadow DOM: the site’s styles do not break it, and its styles do not affect the site. It works under a strict site CSP as long as `script-src` and `connect-src` allow `https://paymway.com`.\n- On click, an invoice is created and the payment page opens in a new window on desktop and in a new tab on mobile. If pop-ups are blocked — in the same tab. The payment page cannot be embedded in an `iframe`.\n- For a “customer enters the amount” button, the `/b/CODE` page with an amount field opens.\n- Tilda: the “HTML code” block (T123). WordPress: the “Custom HTML” block.\n\n### Tilda — cart and automatic payment confirmation\n\nConnected via Tilda’s “Universal payment system”: dashboard → “Payment buttons” → “Tilda” card → “Connect” — there you find the login, the secret and all values for “Advanced settings”. The customer checks out the cart and goes to the payment page; after payment the gateway sends Tilda a signed notification, and the order is marked as paid.\n\n- API URL: `https://paymway.com/tilda/pay`; the Tilda order number becomes the invoice `order_id` (resubmitting the form returns the same invoice).\n- Order signature — “Custom rules”: `{{login}}:{{order_id}}:{{amount}}:{{currency}}:{{secret}}`, SHA-256 (hex).\n- Notification signature: `{{login}}:{{order_id}}:{{amount}}:{{paid}}:{{secret}}`, SHA-256; payment flag `paid = 1`, transaction ID — `transaction_id` (the invoice ID), success response — `OK`. The notification is retried for up to 24 hours until Tilda responds with `OK`; the log is in the same dashboard card.\n\nThe methods below are called by the widget from the customer’s browser. No API key is needed or sent; responses are allowed for any website (CORS, no cookies). The general per-IP rate limits apply.","item":[{"name":"Button data","request":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/public/buttons/:code","host":["{{baseUrl}}"],"path":["api","public","buttons",":code"],"variable":[{"key":"code","value":"","description":"Button code from the dashboard (“Payment buttons” section), e.g. `7KQ2M9XHTA`."}]},"auth":{"type":"noauth"},"description":"Public button data — no API key. A disabled or deleted button, or a button of an inactive store, returns `404`.\n\n_No API key required._\n\n**Path parameters**\n\n- `code` (string, required) — Button code from the dashboard (“Payment buttons” section), e.g. `7KQ2M9XHTA`.\n\n**Errors:** `not_found`\n\nDocumentation: https://paymway.com/en/docs#get-button"},"response":[{"name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/public/buttons/:code","host":["{{baseUrl}}"],"path":["api","public","buttons",":code"],"variable":[{"key":"code","value":"","description":"Button code from the dashboard (“Payment buttons” section), e.g. `7KQ2M9XHTA`."}]},"auth":{"type":"noauth"}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"code\": \"7KQ2M9XHTA\",\n  \"title\": \"1-hour consultation\",\n  \"description\": \"Zoom call\",\n  \"amount\": \"25\",\n  \"currency\": \"USD\",\n  \"custom_amount\": false,\n  \"min_amount\": null,\n  \"max_amount\": null,\n  \"merchant\": {\n    \"name\": \"Shop\"\n  },\n  \"url\": \"https://paymway.com/b/7KQ2M9XHTA\"\n}"}]},{"name":"Invoice from a button","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/public/buttons/:code/invoice","host":["{{baseUrl}}"],"path":["api","public","buttons",":code","invoice"],"variable":[{"key":"code","value":"","description":"Button code from the dashboard (“Payment buttons” section), e.g. `7KQ2M9XHTA`."}]},"body":{"mode":"raw","raw":"{\n  \"email\": \"buyer@example.com\",\n  \"comment\": \"Please do not call\"\n}","options":{"raw":{"language":"json"}}},"auth":{"type":"noauth"},"description":"Creates a new invoice from a button (every call creates a new invoice) and returns the payment page link. No API key; called from the browser on any website.\n\n_No API key required._\n\n**Path parameters**\n\n- `code` (string, required) — Button code from the dashboard (“Payment buttons” section), e.g. `7KQ2M9XHTA`.\n\n**Request body**\n\n- `amount` (string) — Amount for a “customer enters the amount” button — required for it, within `min_amount`…`max_amount`. Ignored for fixed-amount buttons.\n- `email` (string) — Customer email — stored in the invoice `metadata.email`.\n- `comment` (string) — Customer comment (up to 500 characters) — stored in `metadata.comment`.\n- `return_url` (string) — Where to send the customer if they leave without paying. Accepted only if it matches the site the request came from (the `Origin` header); otherwise the button page is used.\n- `lang` (string) — Payment page language, e.g. `ru` or `en`.\n\n**Errors:** `not_found`, `amount_required`, `invalid_amount`, `amount_too_small`, `amount_too_large`, `validation_error`, `rate_limited`\n\nDocumentation: https://paymway.com/en/docs#create-button-invoice"},"response":[{"name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/public/buttons/:code/invoice","host":["{{baseUrl}}"],"path":["api","public","buttons",":code","invoice"],"variable":[{"key":"code","value":"","description":"Button code from the dashboard (“Payment buttons” section), e.g. `7KQ2M9XHTA`."}]},"body":{"mode":"raw","raw":"{\n  \"email\": \"buyer@example.com\",\n  \"comment\": \"Please do not call\"\n}","options":{"raw":{"language":"json"}}},"auth":{"type":"noauth"}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"body":"{\n  \"id\": \"6722fb9d-ed9e-4710-9f08-c9b63600b25a\",\n  \"payment_url\": \"https://paymway.com/pay/6722fb9d-ed9e-4710-9f08-c9b63600b25a\"\n}"}]}]}]}