{ "info": { "name": "SET API and SET Merchant API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Every /v1 call SET Docs documents, for a platform key or a merchant key, and the recipe folders. Set setApiKey to a set_test_… key (https://simpleeasytransactions.com/docs/overview/sandbox-key); baseUrl is staging. Guide: https://simpleeasytransactions.com/docs/collections/postman" }, "variable": [ { "key": "baseUrl", "value": "https://wallet-staging.simpleeasytransactions.com" }, { "key": "setApiKey", "value": "" }, { "key": "externalId", "value": "" }, { "key": "name", "value": "" }, { "key": "email", "value": "" }, { "key": "amount", "value": "1000.00" }, { "key": "sellerName", "value": "" }, { "key": "sellerAddress", "value": "" }, { "key": "reserveName", "value": "" }, { "key": "reserveAddress", "value": "" }, { "key": "sellerAmount", "value": "850.00" }, { "key": "reserveAmount", "value": "80.00" }, { "key": "order", "value": "" } ], "item": [ { "name": "Recipe: Marketplace split", "description": "Collect one buyer payment into the seller's own wallet, then pay each share (seller, tax reserve) in one payout batch.\n\nSet these collection variables first: externalId, name, email, amount, sellerName, sellerAddress, reserveName, reserveAddress, sellerAmount, reserveAmount, order. Each request keeps what the next one needs.\n\n1. The seller, as your customer\n2. The seller completes verification (outside SET: The seller completes the hosted verification at kycLink (or you send KYB by API). Go on when GET /v1/customers/{customer} reads approved. On staging: Approve the test customer.)\n3. The seller's wallet\n4. A virtual account that settles to the wallet\n5. The buyer pays (outside SET: The buyer pays amount into the virtual account's depositInstructions. Go on when deposit.payment_processed arrives and the wallet holds the USDC. On staging: A simulated deposit.)\n6. (staging) The deposit: payment_submitted (staging only)\n7. (staging) The deposit: payment_processed (staging only)\n8. The seller, as a recipient\n9. The tax reserve, as a recipient\n10. Pay every share in one batch\n11. (staging) The seller's payout: payment_submitted (staging only)\n12. (staging) The seller's payout: payment_processed (staging only)\n13. (staging) The reserve's payout: payment_submitted (staging only)\n14. (staging) The reserve's payout: payment_processed (staging only)\n15. The batch, its items and counts\n\nGuide: https://simpleeasytransactions.com/docs/set-api/marketplace-splits", "item": [ { "name": "The seller, as your customer", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"The seller, as your customer: HTTP 200 or 201\", () => pm.expect([200,201]).to.include(pm.response.code));", "const answer = pm.response.json();", "const pick = (value, path) => path.split(\".\").reduce((node, key) => (node === null || node === undefined ? undefined : node[key]), value);", "if (pick(answer, \"id\") != null) pm.collectionVariables.set(\"customer\", String(pick(answer, \"id\")));", "if (pick(answer, \"kycLink\") != null) pm.collectionVariables.set(\"kycLink\", String(pick(answer, \"kycLink\")));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"externalId\": \"{{externalId}}\",\n \"type\": \"business\",\n \"name\": \"{{name}}\",\n \"email\": \"{{email}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "(staging) Approve the test customer", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"(staging) Approve the test customer: HTTP 200\", () => pm.expect([200]).to.include(pm.response.code));", "const answer = pm.response.json();", "const pick = (value, path) => path.split(\".\").reduce((node, key) => (node === null || node === undefined ? undefined : node[key]), value);", "pm.test(\"status is approved\", () => pm.expect([\"approved\"]).to.include(pick(answer, \"status\")));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/customers/{{customer}}/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "customers", "{{customer}}", "approve" ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Staging only: SET's simulated stand-in. Production has no such call." } }, { "name": "The seller's wallet", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"The seller's wallet: HTTP 200 or 201\", () => pm.expect([200,201]).to.include(pm.response.code));", "const answer = pm.response.json();", "const pick = (value, path) => path.split(\".\").reduce((node, key) => (node === null || node === undefined ? undefined : node[key]), value);", "if (pick(answer, \"id\") != null) pm.collectionVariables.set(\"wallet\", String(pick(answer, \"id\")));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/wallets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallets" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"customer\": \"{{customer}}\",\n \"chain\": \"base\"\n}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "A virtual account that settles to the wallet", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"A virtual account that settles to the wallet: HTTP 200 or 201\", () => pm.expect([200,201]).to.include(pm.response.code));", "const answer = pm.response.json();", "const pick = (value, path) => path.split(\".\").reduce((node, key) => (node === null || node === undefined ? undefined : node[key]), value);", "if (pick(answer, \"id\") != null) pm.collectionVariables.set(\"virtualAccount\", String(pick(answer, \"id\")));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/virtual_accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "virtual_accounts" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"customer\": \"{{customer}}\",\n \"settleTo\": {\n \"wallet\": \"{{wallet}}\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "(staging) A simulated deposit", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"(staging) A simulated deposit: HTTP 201\", () => pm.expect([201]).to.include(pm.response.code));", "const answer = pm.response.json();", "const pick = (value, path) => path.split(\".\").reduce((node, key) => (node === null || node === undefined ? undefined : node[key]), value);", "if (pick(answer, \"id\") != null) pm.collectionVariables.set(\"deposit\", String(pick(answer, \"id\")));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/deposits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "deposits" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"virtualAccount\": \"{{virtualAccount}}\",\n \"amount\": \"{{amount}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Staging only: SET's simulated stand-in. Production has no such call." } }, { "name": "(staging) The deposit: payment_submitted", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"(staging) The deposit: payment_submitted: HTTP 200\", () => pm.expect([200]).to.include(pm.response.code));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/deposits/{{deposit}}/advance", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "deposits", "{{deposit}}", "advance" ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Staging only: SET's simulated stand-in. Production has no such call." } }, { "name": "(staging) The deposit: payment_processed", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"(staging) The deposit: payment_processed: HTTP 200\", () => pm.expect([200]).to.include(pm.response.code));", "const answer = pm.response.json();", "const pick = (value, path) => path.split(\".\").reduce((node, key) => (node === null || node === undefined ? undefined : node[key]), value);", "pm.test(\"state is payment_processed\", () => pm.expect([\"payment_processed\"]).to.include(pick(answer, \"state\")));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/deposits/{{deposit}}/advance", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "deposits", "{{deposit}}", "advance" ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Staging only: SET's simulated stand-in. Production has no such call." } }, { "name": "The seller, as a recipient", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"The seller, as a recipient: HTTP 200 or 201\", () => pm.expect([200,201]).to.include(pm.response.code));", "const answer = pm.response.json();", "const pick = (value, path) => path.split(\".\").reduce((node, key) => (node === null || node === undefined ? undefined : node[key]), value);", "if (pick(answer, \"id\") != null) pm.collectionVariables.set(\"sellerRecipient\", String(pick(answer, \"id\")));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"customer\": \"{{customer}}\",\n \"externalId\": \"{{externalId}}-seller\",\n \"party\": {\n \"type\": \"business\",\n \"name\": \"{{sellerName}}\",\n \"address\": {\n \"country\": \"USA\"\n }\n },\n \"destination\": {\n \"kind\": \"wallet\",\n \"chain\": \"base\",\n \"address\": \"{{sellerAddress}}\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "The tax reserve, as a recipient", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"The tax reserve, as a recipient: HTTP 200 or 201\", () => pm.expect([200,201]).to.include(pm.response.code));", "const answer = pm.response.json();", "const pick = (value, path) => path.split(\".\").reduce((node, key) => (node === null || node === undefined ? undefined : node[key]), value);", "if (pick(answer, \"id\") != null) pm.collectionVariables.set(\"reserveRecipient\", String(pick(answer, \"id\")));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"customer\": \"{{customer}}\",\n \"externalId\": \"{{externalId}}-reserve\",\n \"party\": {\n \"type\": \"business\",\n \"name\": \"{{reserveName}}\",\n \"address\": {\n \"country\": \"USA\"\n }\n },\n \"destination\": {\n \"kind\": \"wallet\",\n \"chain\": \"base\",\n \"address\": \"{{reserveAddress}}\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Pay every share in one batch", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"Pay every share in one batch: HTTP 200 or 201\", () => pm.expect([200,201]).to.include(pm.response.code));", "const answer = pm.response.json();", "const pick = (value, path) => path.split(\".\").reduce((node, key) => (node === null || node === undefined ? undefined : node[key]), value);", "if (pick(answer, \"id\") != null) pm.collectionVariables.set(\"batch\", String(pick(answer, \"id\")));", "if (pick(answer, \"items.0.id\") != null) pm.collectionVariables.set(\"sellerPayout\", String(pick(answer, \"items.0.id\")));", "if (pick(answer, \"items.1.id\") != null) pm.collectionVariables.set(\"reservePayout\", String(pick(answer, \"items.1.id\")));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payout_batches", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payout_batches" ], "query": [] }, "body": { "mode": "raw", "raw": "{\n \"wallet\": \"{{wallet}}\",\n \"externalId\": \"{{order}}\",\n \"items\": [\n {\n \"recipient\": \"{{sellerRecipient}}\",\n \"amount\": \"{{sellerAmount}}\",\n \"externalId\": \"{{order}}-seller\"\n },\n {\n \"recipient\": \"{{reserveRecipient}}\",\n \"amount\": \"{{reserveAmount}}\",\n \"externalId\": \"{{order}}-reserve\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "(staging) The seller's payout: payment_submitted", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"(staging) The seller's payout: payment_submitted: HTTP 200\", () => pm.expect([200]).to.include(pm.response.code));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/payouts/{{sellerPayout}}/advance", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "payouts", "{{sellerPayout}}", "advance" ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Staging only: SET's simulated stand-in. Production has no such call." } }, { "name": "(staging) The seller's payout: payment_processed", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"(staging) The seller's payout: payment_processed: HTTP 200\", () => pm.expect([200]).to.include(pm.response.code));", "const answer = pm.response.json();", "const pick = (value, path) => path.split(\".\").reduce((node, key) => (node === null || node === undefined ? undefined : node[key]), value);", "pm.test(\"state is payment_processed\", () => pm.expect([\"payment_processed\"]).to.include(pick(answer, \"state\")));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/payouts/{{sellerPayout}}/advance", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "payouts", "{{sellerPayout}}", "advance" ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Staging only: SET's simulated stand-in. Production has no such call." } }, { "name": "(staging) The reserve's payout: payment_submitted", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"(staging) The reserve's payout: payment_submitted: HTTP 200\", () => pm.expect([200]).to.include(pm.response.code));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/payouts/{{reservePayout}}/advance", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "payouts", "{{reservePayout}}", "advance" ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Staging only: SET's simulated stand-in. Production has no such call." } }, { "name": "(staging) The reserve's payout: payment_processed", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"(staging) The reserve's payout: payment_processed: HTTP 200\", () => pm.expect([200]).to.include(pm.response.code));", "const answer = pm.response.json();", "const pick = (value, path) => path.split(\".\").reduce((node, key) => (node === null || node === undefined ? undefined : node[key]), value);", "pm.test(\"state is payment_processed\", () => pm.expect([\"payment_processed\"]).to.include(pick(answer, \"state\")));" ] } } ], "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/payouts/{{reservePayout}}/advance", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "payouts", "{{reservePayout}}", "advance" ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Staging only: SET's simulated stand-in. Production has no such call." } }, { "name": "The batch, its items and counts", "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test(\"The batch, its items and counts: HTTP 200\", () => pm.expect([200]).to.include(pm.response.code));" ] } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/payout_batches/{{batch}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payout_batches", "{{batch}}" ], "query": [] }, "description": "" } } ] }, { "name": "Audit", "item": [ { "name": "Record a data-subject request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/data_requests", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_requests" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "A person asks to see (export) or erase (delete) what is held about them, for one of your customers. SET's operator answers it; whatSetHolds says what SET keeps and what the provider keeps." } }, { "name": "Your data-subject requests", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/data_requests", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_requests" ], "variable": [], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "Newest first, up to 100." } }, { "name": "Every write by your keys and by SET's operator for you", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/audit_log", "host": [ "{{baseUrl}}" ], "path": [ "v1", "audit_log" ], "variable": [], "query": [ { "key": "actor", "value": "", "disabled": true, "description": "" }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "format", "value": "", "disabled": true, "description": "" } ] }, "description": "Method, path, object, status, request id and time; never a body. Newest first; page with createdBefore = the last answer's nextCreatedBefore. actor: key or operator. format=csv answers the same page as CSV, with the next page in a Link header (rel=\"next\")." } } ] }, { "name": "Banks", "item": [ { "name": "Link a customer's own bank account", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/bank_accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bank_accounts" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "List bank accounts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/bank_accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bank_accounts" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A bank account", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/bank_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "bank_accounts", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } } ] }, { "name": "Card payments", "item": [ { "name": "A Stripe-hosted Checkout (SET Connect, merchant keys)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/card_checkouts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "card_checkouts" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "A payment link: a fixed amount paid by card (merchant keys)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payment_links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payment_links" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Payment links", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/payment_links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payment_links" ], "variable": [], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A payment link", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/payment_links/:link", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payment_links", ":link" ], "variable": [ { "key": "link", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Deactivate a payment link", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payment_links/:link/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payment_links", ":link", "deactivate" ], "variable": [ { "key": "link", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Card payments", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/card_payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "card_payments" ], "variable": [], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A card payment", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/card_payments/:cardPayment", "host": [ "{{baseUrl}}" ], "path": [ "v1", "card_payments", ":cardPayment" ], "variable": [ { "key": "cardPayment", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Refund", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/card_payments/:cardPayment/refunds", "host": [ "{{baseUrl}}" ], "path": [ "v1", "card_payments", ":cardPayment", "refunds" ], "variable": [ { "key": "cardPayment", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } } ] }, { "name": "Cash-Out Addresses", "item": [ { "name": "Open a Cash-Out Address", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/cash_out_addresses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cash_out_addresses" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Pays the customer's bank (bankAccount) or a recipient's (recipient). chain \"evm\" opens one address on every EVM chain the provider supports (in beta): it takes no returnAddress, the provider returns under SET's crypto return policy, and the answer lists the networks the provider supports for the currency." } }, { "name": "List Cash-Out Addresses", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/cash_out_addresses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cash_out_addresses" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A Cash-Out Address", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/cash_out_addresses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cash_out_addresses", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Pay another of the customer's banks", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/cash_out_addresses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cash_out_addresses", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Payments into Cash-Out Addresses", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/cash_out_payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cash_out_payments" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "cashOutAddress", "value": "", "disabled": true, "description": "" }, { "key": "createdSince", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "Newest first. Each carries railReference (components/schemas/RailReference): the bank rail's own reference once the provider reports it." } }, { "name": "A Cash-Out payment", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/cash_out_payments/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cash_out_payments", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } } ] }, { "name": "Conversion Addresses", "item": [ { "name": "Allowed crypto-to-crypto routes", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/conversion_routes", "host": [ "{{baseUrl}}" ], "path": [ "v1", "conversion_routes" ], "variable": [], "query": [] }, "description": "" } }, { "name": "Open a Conversion Address", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/conversion_addresses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "conversion_addresses" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "List Conversion Addresses", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/conversion_addresses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "conversion_addresses" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A Conversion Address", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/conversion_addresses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "conversion_addresses", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Conversion payments", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/conversion_payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "conversion_payments" ], "variable": [], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A Conversion payment", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/conversion_payments/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "conversion_payments", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } } ] }, { "name": "COP", "item": [ { "name": "A COP payment by Colombian bank transfer (PSE)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/cop_payins", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cop_payins" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "The payer pays at the provider's page (startUrl); the customer receives the stablecoin. Minimum 100 COP. PSE payments are non-returnable." } }, { "name": "COP payments by bank transfer", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/cop_payins", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cop_payins" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A COP payment, re-read from the provider", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/cop_payins/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cop_payins", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } } ] }, { "name": "Customers", "item": [ { "name": "The provider's hosted terms page", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/tos_links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tos_links" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Returns signed_agreement_id on redirectUri." } }, { "name": "Create a customer (hosted link, or KYB/KYC by API)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "List customers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/customers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers" ], "variable": [], "query": [ { "key": "externalId", "value": "", "disabled": true, "description": "" }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." } ] }, "description": "" } }, { "name": "A customer, re-read from the provider", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:customer", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customer" ], "variable": [ { "key": "customer", "value": "" } ], "query": [] }, "description": "" } }, { "name": "A link for a currency's endorsement", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:customer/endorsements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customer", "endorsements" ], "variable": [ { "key": "customer", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "More or corrected KYB/KYC data", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:customer/kyb", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customer", "kyb" ], "variable": [ { "key": "customer", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Add an owner, director or signer", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:customer/associated_persons", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customer", "associated_persons" ], "variable": [ { "key": "customer", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Terms link for an existing customer", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:customer/tos_link", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customer", "tos_link" ], "variable": [ { "key": "customer", "value": "" } ], "query": [ { "key": "redirectUri", "value": "", "disabled": true, "description": "" } ] }, "description": "" } }, { "name": "The provider's requests for information", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:customer/rfis", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customer", "rfis" ], "variable": [ { "key": "customer", "value": "" } ], "query": [ { "key": "state", "value": "", "disabled": true, "description": "" } ] }, "description": "" } }, { "name": "Answer an RFI", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/rfis/:rfi/responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "rfis", ":rfi", "responses" ], "variable": [ { "key": "rfi", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Close a customer", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/customers/:customer/close", "host": [ "{{baseUrl}}" ], "path": [ "v1", "customers", ":customer", "close" ], "variable": [ { "key": "customer", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Deactivates its virtual accounts at the provider, retires its Cash-Out Addresses (in SET: the provider has no liquidation address deactivation), disables its recipients, then customer.closed. Repeatable; custodial wallets are not touched." } } ] }, { "name": "Events", "item": [ { "name": "Every event, in order", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/events", "host": [ "{{baseUrl}}" ], "path": [ "v1", "events" ], "variable": [], "query": [ { "key": "after", "value": "", "disabled": true, "description": "The id of the last event you processed: only events after it, in seq order." }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default." }, { "key": "type", "value": "", "disabled": true, "description": "An event type (payout.paid), or a prefix ending in a dot (payout.)." }, { "key": "createdAfter", "value": "", "disabled": true, "description": "An ISO 8601 time: only events created after it." } ] }, "description": "Oldest first by seq; every event carries its seq. Narrow with type and createdAfter; resume with after." } }, { "name": "One event and its delivery", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/events/:event", "host": [ "{{baseUrl}}" ], "path": [ "v1", "events", ":event" ], "variable": [ { "key": "event", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Send it again", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/events/:event/redeliver", "host": [ "{{baseUrl}}" ], "path": [ "v1", "events", ":event", "redeliver" ], "variable": [ { "key": "event", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "A signed ping to your webhook", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_test" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Webhook URL and signing secret", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_secret", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_secret" ], "variable": [], "query": [] }, "description": "" } }, { "name": "Your webhook URL and event filter", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_endpoint", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_endpoint" ], "variable": [], "query": [] }, "description": "" } }, { "name": "Set your webhook URL and event filter", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_endpoint", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_endpoint" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Every webhook endpoint", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_endpoints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_endpoints" ], "variable": [], "query": [] }, "description": "The first one (id \"primary\", POST /v1/webhook_endpoint) and up to 10 more. Each with status and its delivery health: failures (failed deliveries in a row) and failingSince." } }, { "name": "Add a webhook endpoint", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_endpoints", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_endpoints" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "It receives events recorded from now on, signed with its own secret (in this answer). Each delivery carries SET-Webhook-Endpoint with the endpoint's id." } }, { "name": "One webhook endpoint, with its secret", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_endpoints/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_endpoints", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Change a webhook endpoint's URL or event filter", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_endpoints/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_endpoints", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Delete a webhook endpoint", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_endpoints/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_endpoints", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Its undelivered events are dropped; they stay listed." } }, { "name": "Rotate an endpoint's secret", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_endpoints/:id/rotate_secret", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_endpoints", ":id", "rotate_secret" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "The previous secret also signs for 24 hours." } }, { "name": "Rotate the signing secret", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_endpoint/rotate_secret", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_endpoint", "rotate_secret" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "The previous secret co-signs for 24 hours." } } ] }, { "name": "Invoices", "item": [ { "name": "Create an invoice (merchant keys)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/invoices", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "List invoices", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/invoices", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices" ], "variable": [], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "An invoice", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:invoice", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":invoice" ], "variable": [ { "key": "invoice", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Void an invoice", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:invoice/void", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":invoice", "void" ], "variable": [ { "key": "invoice", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "The payer's claim of a payment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/invoices/:invoice/payment_claims", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoices", ":invoice", "payment_claims" ], "variable": [ { "key": "invoice", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Payments to match", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments" ], "variable": [], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "Match a payment to an invoice", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payments/:id/match", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payments", ":id", "match" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Journal entries", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/journal_entries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "journal_entries" ], "variable": [], "query": [] }, "description": "" } }, { "name": "Export (CSV, JSON, QuickBooks Online)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/journal_entries/export", "host": [ "{{baseUrl}}" ], "path": [ "v1", "journal_entries", "export" ], "variable": [], "query": [ { "key": "month", "value": "", "disabled": true, "description": "" }, { "key": "format", "value": "", "disabled": true, "description": "" } ] }, "description": "" } }, { "name": "Ledger account mapping", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/ledger_mapping", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ledger_mapping" ], "variable": [], "query": [] }, "description": "" } }, { "name": "Set the ledger account mapping", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/ledger_mapping", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ledger_mapping" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Refund a bank or stablecoin payment (a payout to the payer)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/refunds", "host": [ "{{baseUrl}}" ], "path": [ "v1", "refunds" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Refunds", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/refunds", "host": [ "{{baseUrl}}" ], "path": [ "v1", "refunds" ], "variable": [], "query": [ { "key": "payment", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A refund", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/refunds/:refund", "host": [ "{{baseUrl}}" ], "path": [ "v1", "refunds", ":refund" ], "variable": [ { "key": "refund", "value": "" } ], "query": [] }, "description": "" } }, { "name": "A recurring invoice", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/invoice_schedules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoice_schedules" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Recurring invoices", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/invoice_schedules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoice_schedules" ], "variable": [], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A recurring invoice", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/invoice_schedules/:schedule", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoice_schedules", ":schedule" ], "variable": [ { "key": "schedule", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Cancel a recurring invoice", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/invoice_schedules/:schedule/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "invoice_schedules", ":schedule", "cancel" ], "variable": [ { "key": "schedule", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } } ] }, { "name": "Keys", "item": [ { "name": "Who this key is", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/ping", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ping" ], "variable": [], "query": [] }, "description": "" } }, { "name": "The platform's keys", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys" ], "variable": [], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "Prefixes, scopes and labels; never a key. Each with expiresAt, expired, lastUsedAt (written at most once a minute) and rotatedTo." } }, { "name": "Issue a key", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Shown once. Never broader than the calling key. expiresAt: past it the key answers 401 api_key_expired." } }, { "name": "Revoke another key", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys/:key/revoke", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys", ":key", "revoke" ], "variable": [ { "key": "key", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Pin a key to your servers' addresses", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys/:key/allowed_cidrs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys", ":key", "allowed_cidrs" ], "variable": [ { "key": "key", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "allowedCidrs: up to 20 IPv4 or IPv6 addresses or CIDR ranges; [] for any address. A request with the key from anywhere else is 403 ip_not_allowed. A key cannot shut itself out (409 would_lock_out)." } } ] }, { "name": "Metadata", "item": [ { "name": "An object's metadata", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/metadata/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "metadata", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "For a customer, virtual account, bank account, Cash-Out Address, Conversion Address, recipient or payout. Every answer and event already carries each such object's metadata." } }, { "name": "Change an object's metadata", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/metadata/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "metadata", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Keys are set; \"\" or null removes a key; metadata: null clears all. At most 20 keys. A value that looks like an email, has a space, or has a number longer than 8 digits is refused (metadata_personal_data). Creates take metadata in their body too." } } ] }, { "name": "Onboarding", "item": [ { "name": "The white-label page's frame origins and colours", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/onboarding_settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding_settings" ], "variable": [], "query": [] }, "description": "" } }, { "name": "Set frame origins and colours", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/onboarding_settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding_settings" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "A white-label KYB/KYC page for one customer", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/onboarding_sessions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding_sessions" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "The url is shown once." } }, { "name": "An onboarding session", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/onboarding_sessions/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding_sessions", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Cancel an onboarding session", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/onboarding_sessions/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "onboarding_sessions", ":id", "cancel" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } } ] }, { "name": "Payable Email", "item": [ { "name": "Where to pay this email", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payable_emails", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payable_emails" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "The payee's status now", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/payable_emails/:payee", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payable_emails", ":payee" ], "variable": [ { "key": "payee", "value": "" } ], "query": [ { "key": "chain", "value": "", "disabled": true, "description": "" } ] }, "description": "" } }, { "name": "Report a payment you sent on chain", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payable_emails/payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payable_emails", "payments" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } } ] }, { "name": "Payouts", "item": [ { "name": "Create a recipient (a third party)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "List recipients", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/recipients", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A recipient", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/:recipient", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", ":recipient" ], "variable": [ { "key": "recipient", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Disable a recipient", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/recipients/:recipient/disable", "host": [ "{{baseUrl}}" ], "path": [ "v1", "recipients", ":recipient", "disable" ], "variable": [ { "key": "recipient", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Pay a recipient from a custodial wallet", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payouts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payouts" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "List payouts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/payouts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payouts" ], "variable": [], "query": [ { "key": "wallet", "value": "", "disabled": true, "description": "" }, { "key": "recipient", "value": "", "disabled": true, "description": "" }, { "key": "batch", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "Newest first. Each carries railReference (components/schemas/RailReference): the bank rail's own reference once the provider reports it. Null for payouts on chain." } }, { "name": "A payout", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/payouts/:payout", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payouts", ":payout" ], "variable": [ { "key": "payout", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Prefunded payouts: up to 100 from one wallet", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payout_batches", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payout_batches" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "A batch, its items and counts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/payout_batches/:batch", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payout_batches", ":batch" ], "variable": [ { "key": "batch", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Approve a payout waiting for approval", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payouts/:payout/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payouts", ":payout", "approve" ], "variable": [ { "key": "payout", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Needs the approve scope, from a key other than the one that asked. Due now: checked against the balance and sent; with a later scheduleAt: waits for it." } }, { "name": "Reject a payout waiting for approval", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payouts/:payout/reject", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payouts", ":payout", "reject" ], "variable": [ { "key": "payout", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Needs the approve scope. Nothing is sent." } }, { "name": "Cancel a payout waiting for approval or its time", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payouts/:payout/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payouts", ":payout", "cancel" ], "variable": [ { "key": "payout", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "The limits on your keys and recipients", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/payout_limits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payout_limits" ], "variable": [], "query": [] }, "description": "Per payout and per 24 hours, in USDC; null is none. SET sets them." } }, { "name": "A recurring payout", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payout_schedules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payout_schedules" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "The cron makes one payout per run, under this key, with the same limits, approval and checks. Missed runs are skipped." } }, { "name": "Recurring payouts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/payout_schedules", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payout_schedules" ], "variable": [], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A recurring payout", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/payout_schedules/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payout_schedules", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Stop a recurring payout", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payout_schedules/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payout_schedules", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } } ] }, { "name": "Reports", "item": [ { "name": "Your monthly fee share statements", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/kickbacks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "kickbacks" ], "variable": [], "query": [ { "key": "month", "value": "", "disabled": true, "description": "" } ] }, "description": "What SET owes the platform each month: its own markup (platformFeeBps), withheld inside SET's fee, and any share of SET's fee set in its contract (kickbackBps), paid from SET's treasury." } }, { "name": "Where SET pays your fee share", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/kickback_destination", "host": [ "{{baseUrl}}" ], "path": [ "v1", "kickback_destination" ], "variable": [], "query": [] }, "description": "" } }, { "name": "Set where SET pays your fee share", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/kickback_destination", "host": [ "{{baseUrl}}" ], "path": [ "v1", "kickback_destination" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "The provider's current rate, and an estimate", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/exchange_rates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "exchange_rates" ], "variable": [], "query": [ { "key": "from", "value": "", "disabled": true, "description": "" }, { "key": "to", "value": "", "disabled": true, "description": "" }, { "key": "amount", "value": "", "disabled": true, "description": "" } ] }, "description": "" } }, { "name": "A month's totals", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/reports/monthly", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reports", "monthly" ], "variable": [], "query": [ { "key": "month", "value": "", "disabled": true, "description": "" } ] }, "description": "" } }, { "name": "What reached the merchant's banks in a month", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/reports/payouts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "reports", "payouts" ], "variable": [], "query": [ { "key": "month", "value": "", "disabled": true, "description": "" } ] }, "description": "" } }, { "name": "Every money movement as one row, with SET's fee and the platform's share", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/balance_transactions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "balance_transactions" ], "variable": [], "query": [ { "key": "type", "value": "", "disabled": true, "description": "" }, { "key": "createdSince", "value": "", "disabled": true, "description": "" }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." } ] }, "description": "Deposits, Cash-Out payments and payouts carry railReference (components/schemas/RailReference); other types carry null." } } ] }, { "name": "Returns", "item": [ { "name": "Send a dollar deposit back to its sender", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/deposits/:id/return", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deposits", ":id", "return" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "The provider returns ACH, FedNow and wire deposits to the original sender within 90 days, funded from the customer's own custodial wallet. ACH and FedNow: the whole amount; wire: up to it." } }, { "name": "A deposit's return, re-read from the provider", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/deposits/:id/return", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deposits", ":id", "return" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Deposit returns", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/deposit_returns", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deposit_returns" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "Where the provider returns crypto it cannot deliver", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/crypto_return_policies", "host": [ "{{baseUrl}}" ], "path": [ "v1", "crypto_return_policies" ], "variable": [], "query": [] }, "description": "SET's static return addresses at the provider, and whether a multichain (chain \"evm\") address is covered for each currency." } } ] }, { "name": "Sandbox", "item": [ { "name": "A simulated memo deposit", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/static_memo_deposits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "static_memo_deposits" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "A simulated template payment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/static_template_transfers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "static_template_transfers" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Approve a test customer", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/customers/:customer/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "customers", ":customer", "approve" ], "variable": [ { "key": "customer", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "A simulated deposit", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/deposits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "deposits" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Advance a simulated deposit", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/deposits/:simDeposit/advance", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "deposits", ":simDeposit", "advance" ], "variable": [ { "key": "simDeposit", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "A simulated Cash-Out payment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/cash_out_payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "cash_out_payments" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Advance it", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/cash_out_payments/:simDrain/advance", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "cash_out_payments", ":simDrain", "advance" ], "variable": [ { "key": "simDrain", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "A simulated Conversion payment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/conversion_payments", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "conversion_payments" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Advance it", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/conversion_payments/:simConversion/advance", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "conversion_payments", ":simConversion", "advance" ], "variable": [ { "key": "simConversion", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Advance a payout one step", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/payouts/:payout/advance", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "payouts", ":payout", "advance" ], "variable": [ { "key": "payout", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Run one simulated outcome", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/sandbox/scenarios", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sandbox", "scenarios" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Staging only; every result is labelled \"Sandbox: simulated\". object: a customer (kyb_rejected, rfi_raised), a virtual account or sim_dep_ (deposit_in_review_then_refunded, microdeposit), a Cash-Out Address or sim_drain_ (cash_out_payment_returned), a payout (payout_returned, payout_undeliverable) or a wallet (wallet_initiation_required). clear: true ends kyb_rejected, rfi_raised, microdeposit or wallet_initiation_required." } } ] }, { "name": "Senders", "item": [ { "name": "Who paid (Travel Rule)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/cash_out_payments/:id/sender", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cash_out_payments", ":id", "sender" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Who paid (Travel Rule)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/deposits/:id/sender", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deposits", ":id", "sender" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Who paid into a memo (Travel Rule)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_memo_deposits/:id/sender", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_memo_deposits", ":id", "sender" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Who paid into a template (Travel Rule)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_template_transfers/:id/sender", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_template_transfers", ":id", "sender" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Saved payers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/payers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payers" ], "variable": [], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "Save a payer", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payers" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Forget a payer", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payers/:payer", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payers", ":payer" ], "variable": [ { "key": "payer", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Who paid (Travel Rule)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/conversion_payments/:id/sender", "host": [ "{{baseUrl}}" ], "path": [ "v1", "conversion_payments", ":id", "sender" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Who sent a direct deposit", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/wallets/:id/activity/:eventId/sender", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallets", ":id", "activity", ":eventId", "sender" ], "variable": [ { "key": "id", "value": "" }, { "key": "eventId", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } } ] }, { "name": "Statements", "item": [ { "name": "Build a customer's monthly statement", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/statements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "statements" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Precomputed in steps; each read of the statement builds more. rebuild: true replaces a ready one." } }, { "name": "List statements", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/statements", "host": [ "{{baseUrl}}" ], "path": [ "v1", "statements" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "month", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A statement: state, totals, downloads", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/statements/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "statements", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "The statement as CSV", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/statements/:id/csv", "host": [ "{{baseUrl}}" ], "path": [ "v1", "statements", ":id", "csv" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "The statement as PDF", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/statements/:id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "statements", ":id", "pdf" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "A year's payouts with their verification", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/tax/payouts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tax", "payouts" ], "variable": [], "query": [ { "key": "year", "value": "", "disabled": true, "description": "" }, { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "format", "value": "", "disabled": true, "description": "" } ] }, "description": "" } }, { "name": "A year's payouts per customer and recipient, with the 1099 threshold", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/tax/1099", "host": [ "{{baseUrl}}" ], "path": [ "v1", "tax", "1099" ], "variable": [], "query": [ { "key": "year", "value": "", "disabled": true, "description": "" }, { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "format", "value": "", "disabled": true, "description": "" } ] }, "description": "" } } ] }, { "name": "Static memos", "item": [ { "name": "A memo on a shared USD account", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_memos", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_memos" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "Payers send wire or ACH with the memo; the provider delivers the stablecoin. No microdeposit verification. The provider deprecates static memos in favour of static templates but keeps supporting them." } }, { "name": "Static memos; match one by memo", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_memos", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_memos" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "memo", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A static memo, with deposit instructions read from the provider", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_memos/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_memos", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "The memo's activity at the provider", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_memos/:id/history", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_memos", ":id", "history" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Deposits into static memos; match by memo", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_memo_deposits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_memo_deposits" ], "variable": [], "query": [ { "key": "staticMemo", "value": "", "disabled": true, "description": "" }, { "key": "memo", "value": "", "disabled": true, "description": "" }, { "key": "createdSince", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A static memo deposit", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_memo_deposits/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_memo_deposits", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } } ] }, { "name": "Static templates", "item": [ { "name": "Standing deposit instructions with a reference (the provider's successor to static memos)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_templates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_templates" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "USD (wire, ACH push), EUR (SEPA) or GBP (Faster Payments) in; each payment the provider matches becomes a static template transfer." } }, { "name": "Static templates; match one by memo", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_templates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_templates" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "memo", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A static template, with deposit instructions read from the provider", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_templates", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Cancel a static template", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_templates/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_templates", ":id", "cancel" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Payments into static templates; match by memo", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_template_transfers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_template_transfers" ], "variable": [], "query": [ { "key": "staticTemplate", "value": "", "disabled": true, "description": "" }, { "key": "memo", "value": "", "disabled": true, "description": "" }, { "key": "createdSince", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A payment into a static template", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/static_template_transfers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "static_template_transfers", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } } ] }, { "name": "Transfers", "item": [ { "name": "A one-off transfer: a wire in to USDC, or a wallet to SWIFT", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/transfers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transfers" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "wire_to_usdc answers with the provider's deposit instructions, including the deposit message the wire must carry." } }, { "name": "List transfers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/transfers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transfers" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "kind", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A transfer, re-read from the provider", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/transfers/:transfer", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transfers", ":transfer" ], "variable": [ { "key": "transfer", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Execute a pending USDT trade at the market rate", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/transfers/:transfer/execute", "host": [ "{{baseUrl}}" ], "path": [ "v1", "transfers", ":transfer", "execute" ], "variable": [ { "key": "transfer", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "The provider refuses a transfer with no pending trade." } }, { "name": "Funds requests banks raised against a customer's deposits", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/funds_requests", "host": [ "{{baseUrl}}" ], "path": [ "v1", "funds_requests" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "" }, { "key": "startingAfter", "value": "", "disabled": true, "description": "" } ] }, "description": "" } } ] }, { "name": "Virtual accounts", "item": [ { "name": "Open a virtual account", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/virtual_accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "virtual_accounts" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "List virtual accounts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/virtual_accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "virtual_accounts" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A virtual account with its deposit instructions", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/virtual_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "virtual_accounts", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Verification deposits", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/virtual_accounts/:id/microdeposits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "virtual_accounts", ":id", "microdeposits" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "" } ] }, "description": "" } }, { "name": "Deactivate", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/virtual_accounts/:id/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "virtual_accounts", ":id", "deactivate" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Reactivate", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/virtual_accounts/:id/reactivate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "virtual_accounts", ":id", "reactivate" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Deposits", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/deposits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deposits" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "virtualAccount", "value": "", "disabled": true, "description": "" }, { "key": "createdSince", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "Newest first. Each carries railReference (components/schemas/RailReference): the bank rail's own reference once the provider reports it." } }, { "name": "A deposit, with who sent it", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/deposits/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deposits", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } } ] }, { "name": "Wallets", "item": [ { "name": "Open a custodial wallet for a customer", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/wallets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallets" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "List wallets", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/wallets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallets" ], "variable": [], "query": [ { "key": "customer", "value": "", "disabled": true, "description": "" }, { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "A wallet with its balances", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/wallets/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallets", ":id" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "balances are the provider's, read now. Sandbox (staging): also simulatedBalance, what simulated deposits delivered to the wallet less simulated payouts from it; payouts draw on it, and a payout it covers is simulated (advance it with POST /v1/sandbox/payouts/{id}/advance)." } }, { "name": "The provider's history for the wallet", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/wallets/:id/activity", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallets", ":id", "activity" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Withdraw to the customer's own bank", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/wallets/:id/withdrawals", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallets", ":id", "withdrawals" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Withdrawals", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/wallets/:id/withdrawals", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallets", ":id", "withdrawals" ], "variable": [ { "key": "id", "value": "" } ], "query": [ { "key": "limit", "value": "", "disabled": true, "description": "1 to 100; 50 by default (any other value is 50)." }, { "key": "createdBefore", "value": "", "disabled": true, "description": "The last answer's nextCreatedBefore, passed back unchanged; or an ISO 8601 time (rows created before it)." } ] }, "description": "" } }, { "name": "Treasury rule", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/wallets/:id/treasury", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallets", ":id", "treasury" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "description": "" } }, { "name": "Set the treasury rule", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/wallets/:id/treasury", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallets", ":id", "treasury" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Turn the treasury rule off", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/wallets/:id/treasury", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallets", ":id", "treasury" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } }, { "name": "Sweep now", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/wallets/:id/sweeps", "host": [ "{{baseUrl}}" ], "path": [ "v1", "wallets", ":id", "sweeps" ], "variable": [ { "key": "id", "value": "" } ], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } } ] }, { "name": "Ways", "item": [ { "name": "One call per way", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/payment_setups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payment_setups" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "way: wallet, cash_out, bank or balance." } }, { "name": "Your default return addresses", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" } ], "url": { "raw": "{{baseUrl}}/v1/return_addresses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "return_addresses" ], "variable": [], "query": [] }, "description": "" } }, { "name": "Register your default return addresses", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{setApiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/return_addresses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "return_addresses" ], "variable": [], "query": [] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "" } } ] } ] }