{ "info": { "_postman_id": "2e3bc231-3fcc-4170-9c38-eea70ac27b36", "name": "Network API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "lastUpdatedBy": "35240", "uid": "35240-2e3bc231-3fcc-4170-9c38-eea70ac27b36" }, "item": [ { "name": "brands", "item": [ { "name": "{brand_id}", "item": [ { "name": "Retrieve brand", "id": "0571b156-3a70-4874-a122-27663348e10d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/brands/:brand_id", "host": [ "{{baseUrl}}" ], "path": [ "brands", ":brand_id" ], "variable": [ { "id": "14ab34c3-b1b6-41b4-b929-81f5726c5db6", "key": "brand_id", "value": "", "description": "(Required) " } ] }, "description": "Returns a brand matching the given `brand_id`.\n\n**This endpoint is not rate limited.**\n\nScopes: `BRANDS_READ`" }, "response": [ { "id": "d72fc27d-cf1c-4b07-8886-428b47fee4c6", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/brands/:brand_id", "host": [ "{{baseUrl}}" ], "path": [ "brands", ":brand_id" ], "variable": [ { "key": "brand_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"brand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"color\": \"\",\n \"profile_image_url\": \"https://example.com\",\n \"metadata\": {\n \"consequat_bb\": \"\",\n \"ametcc2\": \"\",\n \"eiusmoda0d\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-d72fc27d-cf1c-4b07-8886-428b47fee4c6" }, { "id": "2ba2d3ed-81c6-437c-ad13-b060a511beda", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/brands/:brand_id", "host": [ "{{baseUrl}}" ], "path": [ "brands", ":brand_id" ], "variable": [ { "key": "brand_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-2ba2d3ed-81c6-437c-ad13-b060a511beda" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-0571b156-3a70-4874-a122-27663348e10d" }, { "name": "Update brand", "id": "216c0d41-cc8f-44e9-9083-3ce8087b6a76", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"brand\": {\n \"name\": \"\",\n \"reference_id\": \"\",\n \"profile_image_url\": \"\",\n \"color\": \"\",\n \"metadata\": {\n \"voluptate_4\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/brands/:brand_id", "host": [ "{{baseUrl}}" ], "path": [ "brands", ":brand_id" ], "variable": [ { "id": "1edfa9f2-58a1-4641-a320-a98d6daab052", "key": "brand_id", "value": "", "description": "(Required) " } ] }, "description": "Updates a brand matching the provided `brand_id` with the given attributes.\n\nTo clear a field, set it to `null`. Fields that are not provided in the request will not be changed.\n\n**This endpoint is not rate limited.**\n\nScopes: `BRANDS_WRITE`" }, "response": [ { "id": "eb900456-cf66-41f0-b22d-0a3f03b89430", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"brand\": {\n \"name\": \"\",\n \"reference_id\": \"\",\n \"profile_image_url\": \"\",\n \"color\": \"\",\n \"metadata\": {\n \"voluptate_4\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/brands/:brand_id", "host": [ "{{baseUrl}}" ], "path": [ "brands", ":brand_id" ], "variable": [ { "key": "brand_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"brand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"color\": \"\",\n \"profile_image_url\": \"https://example.com\",\n \"metadata\": {\n \"culpa96\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-eb900456-cf66-41f0-b22d-0a3f03b89430" }, { "id": "c95b919c-4008-4ba9-a678-462145e8cdb7", "name": "Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"brand\": {\n \"name\": \"\",\n \"reference_id\": \"\",\n \"profile_image_url\": \"\",\n \"color\": \"\",\n \"metadata\": {\n \"voluptate_4\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/brands/:brand_id", "host": [ "{{baseUrl}}" ], "path": [ "brands", ":brand_id" ], "variable": [ { "key": "brand_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-c95b919c-4008-4ba9-a678-462145e8cdb7" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-216c0d41-cc8f-44e9-9083-3ce8087b6a76" } ], "id": "ad560495-9fa0-4d63-ad91-750fbf47b1a7", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-ad560495-9fa0-4d63-ad91-750fbf47b1a7" }, { "name": "List brands", "id": "8664c0c7-0e27-492a-a2b8-c9a7be14f2ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/brands?cursor=&limit=50&reference_id=", "host": [ "{{baseUrl}}" ], "path": [ "brands" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of brands to return.", "key": "limit", "value": "50" }, { "description": "Filters results to only include brands with a `reference_id` matching the given value.", "key": "reference_id", "value": "" } ] }, "description": "Returns a list of brands matching the given query parameters.\n\n**This endpoint is rate limited to 50 QPS.**\n\nScopes: `BRANDS_READ`" }, "response": [ { "id": "3bafd0b7-bb7f-4fa5-8aef-909f5df7f099", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/brands?cursor=&limit=50&reference_id=", "host": [ "{{baseUrl}}" ], "path": [ "brands" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of brands to return.", "key": "limit", "value": "50" }, { "description": "Filters results to only include brands with a `reference_id` matching the given value.", "key": "reference_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"brands\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"color\": \"\",\n \"profile_image_url\": \"https://example.com\",\n \"metadata\": {\n \"esse_7b\": \"\",\n \"exercitation_21c\": \"\",\n \"reprehenderitc0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"color\": \"\",\n \"profile_image_url\": \"https://example.com\",\n \"metadata\": {\n \"pariatur7\": \"\"\n }\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-3bafd0b7-bb7f-4fa5-8aef-909f5df7f099" }, { "id": "7236cffd-66dc-4280-b38f-c8758fe757d4", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/brands?cursor=&limit=50&reference_id=", "host": [ "{{baseUrl}}" ], "path": [ "brands" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of brands to return.", "key": "limit", "value": "50" }, { "description": "Filters results to only include brands with a `reference_id` matching the given value.", "key": "reference_id", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-7236cffd-66dc-4280-b38f-c8758fe757d4" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-8664c0c7-0e27-492a-a2b8-c9a7be14f2ac" }, { "name": "Create brand", "id": "ca625aec-8c9a-4eaa-a380-6fafbad29758", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"brand\": {\n \"name\": \"\",\n \"reference_id\": \"\",\n \"profile_image_url\": \"\",\n \"color\": \"\",\n \"metadata\": {\n \"cillum_b\": \"\",\n \"sint3_\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/brands", "host": [ "{{baseUrl}}" ], "path": [ "brands" ] }, "description": "Creates a new brand with the given attributes.\n\n**This endpoint is not rate limited.**\n\nScopes: `BRANDS_WRITE`" }, "response": [ { "id": "f3cb53fb-a52b-40e3-88a9-e60ec1ac6d37", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"brand\": {\n \"name\": \"\",\n \"reference_id\": \"\",\n \"profile_image_url\": \"\",\n \"color\": \"\",\n \"metadata\": {\n \"cillum_b\": \"\",\n \"sint3_\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/brands", "host": [ "{{baseUrl}}" ], "path": [ "brands" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"brand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"color\": \"\",\n \"profile_image_url\": \"https://example.com\",\n \"metadata\": {\n \"Duis4d\": \"\",\n \"pariatur9\": \"\",\n \"magna_e\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-f3cb53fb-a52b-40e3-88a9-e60ec1ac6d37" }, { "id": "3d3369cb-34f9-4566-9ae8-3f4f72ab4670", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"brand\": {\n \"name\": \"\",\n \"reference_id\": \"\",\n \"profile_image_url\": \"\",\n \"color\": \"\",\n \"metadata\": {\n \"cillum_b\": \"\",\n \"sint3_\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/brands", "host": [ "{{baseUrl}}" ], "path": [ "brands" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-3d3369cb-34f9-4566-9ae8-3f4f72ab4670" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-ca625aec-8c9a-4eaa-a380-6fafbad29758" }, { "name": "Upsert brand", "id": "b65e63ed-1a9a-4cd1-8bce-b8978b72992c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"brand\": {\n \"name\": \"\",\n \"reference_id\": \"\",\n \"profile_image_url\": \"\",\n \"color\": \"\",\n \"metadata\": {\n \"Duis_cd\": \"\",\n \"eu7af\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/brands", "host": [ "{{baseUrl}}" ], "path": [ "brands" ] }, "description": "Creates or updates a brand based on the brand's `reference_id`.\n\nIf a brand with a matching `reference_id` is found, \nit will be updated. Ensure proper mapping; if no matching brand is found, \na new one will be created. \n\nThe HTTP response code (`200 OK` or `201 Created`) indicates\nwhether the resource was updated or created, respectively.\n\n\n\n `brand_id` is the primary unique identifier for all Brand APIs.\n Be cautious when using `reference_id` as a unique identifier. \n\n\n**This endpoint is not rate limited.**\n\nScopes: `BRANDS_WRITE`" }, "response": [ { "id": "b648b0d2-c1c0-435e-bed7-88f03d55b480", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"brand\": {\n \"name\": \"\",\n \"reference_id\": \"\",\n \"profile_image_url\": \"\",\n \"color\": \"\",\n \"metadata\": {\n \"Duis_cd\": \"\",\n \"eu7af\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/brands", "host": [ "{{baseUrl}}" ], "path": [ "brands" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"brand\": {\n \"id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"color\": \"\",\n \"profile_image_url\": \"https://example.com\",\n \"metadata\": {\n \"aliquip_1\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b648b0d2-c1c0-435e-bed7-88f03d55b480" }, { "id": "e887e2ad-bbdf-4807-95c6-929a09fb41fc", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"brand\": {\n \"name\": \"\",\n \"reference_id\": \"\",\n \"profile_image_url\": \"\",\n \"color\": \"\",\n \"metadata\": {\n \"Duis_cd\": \"\",\n \"eu7af\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/brands", "host": [ "{{baseUrl}}" ], "path": [ "brands" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-e887e2ad-bbdf-4807-95c6-929a09fb41fc" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b65e63ed-1a9a-4cd1-8bce-b8978b72992c" } ], "id": "a5db2cb4-914b-411c-b401-02767909ff81", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-a5db2cb4-914b-411c-b401-02767909ff81" }, { "name": "merchants", "item": [ { "name": "{merchant_id}", "item": [ { "name": "Retrieve merchant", "id": "f8f89507-f213-4905-b995-12caee6697e6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchant_id", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchant_id" ], "variable": [ { "id": "be7738f3-0de9-4ec9-8fb8-0348efc4468c", "key": "merchant_id", "value": "", "description": "(Required) " } ] }, "description": "Returns a merchant matching the given `merchant_id`.\n\n**This endpoint is not rate limited.**\n\nScopes: `MERCHANTS_READ`" }, "response": [ { "id": "61da59f2-894e-4e2a-a87b-858774d34af0", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchant_id", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchant_id" ], "variable": [ { "key": "merchant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchant\": {\n \"id\": \"\",\n \"brand_id\": \"\",\n \"name\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"status\": \"PENDING\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"in_3f\": \"\",\n \"id_86\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-61da59f2-894e-4e2a-a87b-858774d34af0" }, { "id": "f7a68240-f826-4ffb-ad2a-ab5a4338e135", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/merchants/:merchant_id", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchant_id" ], "variable": [ { "key": "merchant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-f7a68240-f826-4ffb-ad2a-ab5a4338e135" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-f8f89507-f213-4905-b995-12caee6697e6" }, { "name": "Update merchant", "id": "ac6f4b38-96f6-423f-b034-ded2748987a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"merchant\": {\n \"brand_id\": \"\",\n \"category\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"name\": \"\",\n \"reference_id\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"status\": \"ACTIVE\",\n \"metadata\": {\n \"adipisicing1\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants/:merchant_id", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchant_id" ], "variable": [ { "id": "9598ab5b-859e-4848-be8a-bf7c9df1c9a1", "key": "merchant_id", "value": "", "description": "(Required) " } ] }, "description": "Updates a merchant matching the provided `merchant_id` with the given attributes.\n\nTo clear a field, set it to `null`. Fields that are not provided in the request will not be changed.\n\n**This endpoint is not rate limited.**\n\nScopes: `MERCHANTS_WRITE`" }, "response": [ { "id": "38fdeacf-e7ae-41d5-9aba-096b7dfa62ef", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"merchant\": {\n \"brand_id\": \"\",\n \"category\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"name\": \"\",\n \"reference_id\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"status\": \"ACTIVE\",\n \"metadata\": {\n \"adipisicing1\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants/:merchant_id", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchant_id" ], "variable": [ { "key": "merchant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchant\": {\n \"id\": \"\",\n \"brand_id\": \"\",\n \"name\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"status\": \"COMPLIANCE_DISABLED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"enim3d\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-38fdeacf-e7ae-41d5-9aba-096b7dfa62ef" }, { "id": "4d2e81e0-514d-4fa1-971f-5ec10d81ed1a", "name": "Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"merchant\": {\n \"brand_id\": \"\",\n \"category\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"name\": \"\",\n \"reference_id\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"status\": \"ACTIVE\",\n \"metadata\": {\n \"adipisicing1\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants/:merchant_id", "host": [ "{{baseUrl}}" ], "path": [ "merchants", ":merchant_id" ], "variable": [ { "key": "merchant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-4d2e81e0-514d-4fa1-971f-5ec10d81ed1a" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-ac6f4b38-96f6-423f-b034-ded2748987a7" } ], "id": "d9d95774-6aaf-4cb2-a36c-4349b338df7d", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-d9d95774-6aaf-4cb2-a36c-4349b338df7d" }, { "name": "List merchants", "id": "20c19bfa-5d9c-419e-996d-55618785e4c6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/merchants?reference_id=&cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ], "query": [ { "description": "Filters results to only include merchants with a `reference_id` matching the given value.", "key": "reference_id", "value": "" }, { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of merchants to return.", "key": "limit", "value": "50" } ] }, "description": "Returns a list of merchants matching the given query parameters.\n\n**This endpoint is rate limited to 50 QPS.**\n\nScopes: `MERCHANTS_READ`" }, "response": [ { "id": "fe481116-8012-44fc-b7b6-829c7023c601", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/merchants?reference_id=&cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ], "query": [ { "description": "Filters results to only include merchants with a `reference_id` matching the given value.", "key": "reference_id", "value": "" }, { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of merchants to return.", "key": "limit", "value": "50" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchants\": [\n {\n \"id\": \"\",\n \"brand_id\": \"\",\n \"name\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"status\": \"COMPLIANCE_DISABLED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"doloref1\": \"\",\n \"magnabbe\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"brand_id\": \"\",\n \"name\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"status\": \"RISK_DISABLED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"exercitation_4\": \"\",\n \"suntc7\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-fe481116-8012-44fc-b7b6-829c7023c601" }, { "id": "b0d43794-2af6-46e8-81eb-6f548a0c4714", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/merchants?reference_id=&cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ], "query": [ { "description": "Filters results to only include merchants with a `reference_id` matching the given value.", "key": "reference_id", "value": "" }, { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of merchants to return.", "key": "limit", "value": "50" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"DISPUTE_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b0d43794-2af6-46e8-81eb-6f548a0c4714" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-20c19bfa-5d9c-419e-996d-55618785e4c6" }, { "name": "Create merchant", "id": "b01dad29-5cff-4886-b48d-dd4923d4309a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"merchant\": {\n \"name\": \"\",\n \"brand_id\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"consequat2\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] }, "description": "Creates a new merchant. Merchants must have an `address` or `site_url` set.\n\n**This endpoint is not rate limited.**\n\nScopes: `MERCHANTS_WRITE`" }, "response": [ { "id": "44023b61-6b44-4ccf-8394-b2c3475529fa", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"merchant\": {\n \"name\": \"\",\n \"brand_id\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"consequat2\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchant\": {\n \"id\": \"\",\n \"brand_id\": \"\",\n \"name\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"status\": \"COMPLIANCE_DISABLED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"ea7\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-44023b61-6b44-4ccf-8394-b2c3475529fa" }, { "id": "df04163f-5755-4b53-9853-51ee0af57d06", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"merchant\": {\n \"name\": \"\",\n \"brand_id\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"consequat2\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-df04163f-5755-4b53-9853-51ee0af57d06" }, { "id": "28a5a8f1-0001-4947-8180-638268a800bc", "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"merchant\": {\n \"name\": \"\",\n \"brand_id\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"consequat2\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-28a5a8f1-0001-4947-8180-638268a800bc" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b01dad29-5cff-4886-b48d-dd4923d4309a" }, { "name": "Upsert merchant", "id": "4cc9929a-5cf4-42da-92fa-df32b5d97be8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"merchant\": {\n \"name\": \"\",\n \"brand_id\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"aliquip_f\": \"\",\n \"anim_5a\": \"\",\n \"essee\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] }, "description": "Creates or updates a merchant based on the merchant's `reference_id`.\n\nIf a merchant with a matching `reference_id` is found, \nit will be updated. If no matching merchant is found,\na new one will be created.\n\nThe HTTP response code (`200 OK` or `201 Created`) indicates\nwhether the resource was updated or created, respectively.\n\n\n\n `merchant_id` is the primary unique identifier for all Merchant APIs.\n Be cautious when using `reference_id` as a unique identifier.\n \n Merchants must have an `address` or `site_url` set.\n \n\n**This endpoint is not rate limited.**\n\nScopes: `MERCHANTS_WRITE`" }, "response": [ { "id": "d7c47bff-0848-4b00-b394-f7ea0a5a0615", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"merchant\": {\n \"name\": \"\",\n \"brand_id\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"aliquip_f\": \"\",\n \"anim_5a\": \"\",\n \"essee\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"merchant\": {\n \"id\": \"\",\n \"brand_id\": \"\",\n \"name\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"status\": \"PENDING\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"in_c\": \"\",\n \"ea72_\": \"\",\n \"Lorem_fa\": \"\",\n \"commodo7\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-d7c47bff-0848-4b00-b394-f7ea0a5a0615" }, { "id": "4f2af4b7-4a88-4ac4-89d2-e917187ece40", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"merchant\": {\n \"name\": \"\",\n \"brand_id\": \"\",\n \"country\": \"US\",\n \"currency\": \"USD\",\n \"category\": \"\",\n \"reference_id\": \"\",\n \"address\": {\n \"country\": \"US\",\n \"address_line_1\": \"\",\n \"address_line_2\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"administrative_district_level_1\": \"\"\n },\n \"site_url\": \"\",\n \"metadata\": {\n \"aliquip_f\": \"\",\n \"anim_5a\": \"\",\n \"essee\": \"\"\n },\n \"default_fee_plans\": {\n \"in_app_fee_plan_id\": \"\",\n \"in_person_fee_plan_id\": \"\",\n \"online_fee_plan_id\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/merchants", "host": [ "{{baseUrl}}" ], "path": [ "merchants" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-4f2af4b7-4a88-4ac4-89d2-e917187ece40" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-4cc9929a-5cf4-42da-92fa-df32b5d97be8" } ], "id": "635265e5-5ffa-44c4-8bc0-cfd1ec2c825a", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-635265e5-5ffa-44c4-8bc0-cfd1ec2c825a" }, { "name": "customers", "item": [ { "name": "{customer_id}", "item": [ { "name": "grants", "item": [ { "name": "{grant_id}", "item": [ { "name": "revoke", "item": [ { "name": "Revoke customer grant", "id": "a825fdf7-c567-4229-b321-e6be9b06f64d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id/grants/:grant_id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id", "grants", ":grant_id", "revoke" ], "variable": [ { "id": "510c36fe-1ba0-43d7-9bdb-abe20fe719ee", "key": "customer_id", "value": "", "description": "(Required) " }, { "id": "b068cadc-5ea2-4df5-950b-3f418e320ca5", "key": "grant_id", "value": "", "description": "(Required) " } ] }, "description": "Revokes a customer grant, rendering it unusable. Other endpoints will no longer be able to use the grant to perform its associated action.\n\n \nYou cannot un-revoke a grant. Use with caution.\n\n\n**This endpoint is not rate limited.**\n\nScopes: `GRANTS_WRITE`" }, "response": [ { "id": "a545fcdc-e90b-4f22-802e-ea8d63188920", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id/grants/:grant_id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id", "grants", ":grant_id", "revoke" ], "variable": [ { "key": "customer_id" }, { "key": "grant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"grant\": {\n \"id\": \"\",\n \"customer_id\": \"\",\n \"request_id\": \"\",\n \"action\": {\n \"scope_id\": \"\",\n \"type\": \"ONE_TIME_PAYMENT\",\n \"amount\": \"\",\n \"currency\": \"USD\"\n },\n \"status\": \"ACTIVE\",\n \"type\": \"ONE_TIME\",\n \"channel\": \"IN_APP\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-a545fcdc-e90b-4f22-802e-ea8d63188920" }, { "id": "8f0b7893-5ff5-4212-ba0c-1e4b7ca765fb", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id/grants/:grant_id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id", "grants", ":grant_id", "revoke" ], "variable": [ { "key": "customer_id" }, { "key": "grant_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-8f0b7893-5ff5-4212-ba0c-1e4b7ca765fb" }, { "id": "45879b31-4a61-4c8d-9a27-e40287dbc501", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id/grants/:grant_id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id", "grants", ":grant_id", "revoke" ], "variable": [ { "key": "customer_id" }, { "key": "grant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-45879b31-4a61-4c8d-9a27-e40287dbc501" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-a825fdf7-c567-4229-b321-e6be9b06f64d" } ], "id": "24995168-18fe-4b9d-9df6-3af3b906098c", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-24995168-18fe-4b9d-9df6-3af3b906098c" }, { "name": "Retrieve customer grant", "id": "c3b94d97-7f06-4e89-bd8c-10c5b5aa3d87", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id/grants/:grant_id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id", "grants", ":grant_id" ], "variable": [ { "id": "bf9b75b1-80fa-42ba-9bf8-f792c62c8843", "key": "customer_id", "value": "", "description": "(Required) " }, { "id": "662d5c4d-36f6-46f4-ad98-4a140e312bc4", "key": "grant_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a customer grant by the ID of the customer that approved it and its own ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `GRANTS_READ`" }, "response": [ { "id": "fcb7f505-79ab-4b3f-a3e9-fae88856a389", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id/grants/:grant_id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id", "grants", ":grant_id" ], "variable": [ { "key": "customer_id" }, { "key": "grant_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"grant\": {\n \"id\": \"\",\n \"customer_id\": \"\",\n \"request_id\": \"\",\n \"action\": {\n \"scope_id\": \"\",\n \"type\": \"ONE_TIME_PAYMENT\",\n \"amount\": \"\",\n \"currency\": \"USD\"\n },\n \"status\": \"EXPIRED\",\n \"type\": \"EXTENDED\",\n \"channel\": \"IN_PERSON\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-fcb7f505-79ab-4b3f-a3e9-fae88856a389" }, { "id": "922f0858-54b8-4ecd-9dd2-30481e856320", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id/grants/:grant_id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id", "grants", ":grant_id" ], "variable": [ { "key": "customer_id" }, { "key": "grant_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-922f0858-54b8-4ecd-9dd2-30481e856320" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-c3b94d97-7f06-4e89-bd8c-10c5b5aa3d87" } ], "id": "174e54f9-daf5-4c73-a5c0-d61130133529", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-174e54f9-daf5-4c73-a5c0-d61130133529" }, { "name": "List customer grants", "id": "85966d6f-012e-413c-8043-d99dd7f426f8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id/grants?cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id", "grants" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of customer grants to return", "key": "limit", "value": "50" } ], "variable": [ { "id": "334537ba-99a2-4cc7-b852-99c73c0fb74f", "key": "customer_id", "value": "", "description": "(Required) " } ] }, "description": "Returns a list of all customer grants for a given customer that match the provided query parameters.\n\n**This endpoint is rate limited to 250 QPS.**\n\nScopes: `GRANTS_READ`" }, "response": [ { "id": "afefc802-e17d-4f0a-a6ff-3c472c3a3d69", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id/grants?cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id", "grants" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of customer grants to return", "key": "limit", "value": "50" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"grants\": [\n {\n \"id\": \"\",\n \"customer_id\": \"\",\n \"request_id\": \"\",\n \"action\": {\n \"scope_id\": \"\",\n \"type\": \"ONE_TIME_PAYMENT\",\n \"amount\": \"\",\n \"currency\": \"USD\"\n },\n \"status\": \"ACTIVE\",\n \"type\": \"ONE_TIME\",\n \"channel\": \"IN_APP\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\"\n },\n {\n \"id\": \"\",\n \"customer_id\": \"\",\n \"request_id\": \"\",\n \"action\": {\n \"scope_id\": \"\",\n \"type\": \"ONE_TIME_PAYMENT\",\n \"amount\": \"\",\n \"currency\": \"USD\"\n },\n \"status\": \"CONSUMED\",\n \"type\": \"ONE_TIME\",\n \"channel\": \"IN_APP\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"expires_at\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-afefc802-e17d-4f0a-a6ff-3c472c3a3d69" }, { "id": "82d0d9d8-69eb-4f6a-9e8b-c243b55daaa1", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id/grants?cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id", "grants" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of customer grants to return", "key": "limit", "value": "50" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-82d0d9d8-69eb-4f6a-9e8b-c243b55daaa1" }, { "id": "8defb550-336e-43d4-b5b1-51d96949c9be", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id/grants?cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id", "grants" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of customer grants to return", "key": "limit", "value": "50" } ], "variable": [ { "key": "customer_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-8defb550-336e-43d4-b5b1-51d96949c9be" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-85966d6f-012e-413c-8043-d99dd7f426f8" } ], "id": "1cbe5501-6615-4891-94b7-4827aaf64acd", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-1cbe5501-6615-4891-94b7-4827aaf64acd" }, { "name": "Retrieve customer", "id": "ababe204-3ea1-4edb-8624-d3800cb8abda", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id" ], "variable": [ { "id": "b9248c17-ab4e-4f53-845e-542318abf73a", "key": "customer_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a customer by its ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `CUSTOMERS_READ`" }, "response": [ { "id": "4d741b9f-2459-4add-b15a-c60d3d8e924f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id" ], "variable": [ { "key": "customer_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"customer\": {\n \"id\": \"\",\n \"cashtag\": \"\",\n \"reference_id\": \"\"\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-4d741b9f-2459-4add-b15a-c60d3d8e924f" }, { "id": "6075a9d6-2156-4fbf-913e-eaacd08c1297", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers/:customer_id", "host": [ "{{baseUrl}}" ], "path": [ "customers", ":customer_id" ], "variable": [ { "key": "customer_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-6075a9d6-2156-4fbf-913e-eaacd08c1297" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-ababe204-3ea1-4edb-8624-d3800cb8abda" } ], "id": "8eaebd7d-fda9-4fc7-a794-cefe24e7fadb", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-8eaebd7d-fda9-4fc7-a794-cefe24e7fadb" }, { "name": "List customers", "id": "8b5799e6-9877-47c8-a1e5-09e28c82ad83", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers?cursor=&limit=50&cashtag=", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of customers to return.", "key": "limit", "value": "50" }, { "description": "Filters results to only include customers with a matching Cashtag.", "key": "cashtag", "value": "" } ] }, "description": "Returns a list of all customers matching the given query parameters who have ever authorized this client to take an action on their account.\n\n**This endpoint is rate limited to 50 QPS.**\n\nScopes: `CUSTOMERS_READ`" }, "response": [ { "id": "95b10196-5331-4618-b0bc-a7419813dabd", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers?cursor=&limit=50&cashtag=", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of customers to return.", "key": "limit", "value": "50" }, { "description": "Filters results to only include customers with a matching Cashtag.", "key": "cashtag", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"customers\": [\n {\n \"id\": \"\",\n \"cashtag\": \"\",\n \"reference_id\": \"\"\n },\n {\n \"id\": \"\",\n \"cashtag\": \"\",\n \"reference_id\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-95b10196-5331-4618-b0bc-a7419813dabd" }, { "id": "0d5b51e7-c4b4-44ea-924a-21a867581d9a", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customers?cursor=&limit=50&cashtag=", "host": [ "{{baseUrl}}" ], "path": [ "customers" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of customers to return.", "key": "limit", "value": "50" }, { "description": "Filters results to only include customers with a matching Cashtag.", "key": "cashtag", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-0d5b51e7-c4b4-44ea-924a-21a867581d9a" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-8b5799e6-9877-47c8-a1e5-09e28c82ad83" } ], "id": "e1de7f1f-52ae-4af3-8c3f-0b87902ecb48", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-e1de7f1f-52ae-4af3-8c3f-0b87902ecb48" }, { "name": "payments", "item": [ { "name": "{payment_id}", "item": [ { "name": "authorizations", "item": [ { "name": "Create incremental authorization", "id": "9a6bddf5-0d6d-4c74-acac-af4b71270cb5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"authorization\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"qui_4\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/:payment_id/authorizations", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id", "authorizations" ], "variable": [ { "id": "8aab3feb-042d-4168-88b6-57e3ca0db165", "key": "payment_id", "value": "", "description": "(Required) " } ] }, "description": "Creates an authorization update for a payment. The authorization amount must be greater than or equal to the current authorized amount.\n\nUse this endpoint for incremental authorization instead of overcapturing using the Capture payment endpoint. By creating additional payment authorizations exceeding the current authorized amount, you can request additional funds without risking the original amount being declined.\n\n**This endpoint is not rate limited.** \n\nScopes: `PAYMENTS_WRITE`" }, "response": [ { "id": "f1250e92-84ef-4b98-9aa8-21ee169226e3", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"authorization\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"qui_4\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/:payment_id/authorizations", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id", "authorizations" ], "variable": [ { "key": "payment_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"authorization\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"est_bd\": \"\",\n \"ind\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-f1250e92-84ef-4b98-9aa8-21ee169226e3" }, { "id": "7117b068-ff11-4f10-9047-7b4715a24cce", "name": "Bad Request\n\nIf a AUTHORIZATION_DECLINE_* error is returned, the authorization will still be created, but with a DECLINED status. This authorization will then appear in the response payload.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"authorization\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"qui_4\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/:payment_id/authorizations", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id", "authorizations" ], "variable": [ { "key": "payment_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_KEY_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"authorization\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"reprehenderit_75\": \"\",\n \"enim5\": \"\",\n \"do00e\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"PAYMENT_PROCESSING_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"GRANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-7117b068-ff11-4f10-9047-7b4715a24cce" }, { "id": "d803bd14-c5f0-4ff1-a4c7-238ddd3f5722", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"authorization\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"qui_4\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/:payment_id/authorizations", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id", "authorizations" ], "variable": [ { "key": "payment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-d803bd14-c5f0-4ff1-a4c7-238ddd3f5722" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-9a6bddf5-0d6d-4c74-acac-af4b71270cb5" } ], "id": "cd6e0de0-48f5-4b2c-b0d7-c9e4ce3ba46a", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-cd6e0de0-48f5-4b2c-b0d7-c9e4ce3ba46a" }, { "name": "capture", "item": [ { "name": "Capture payment", "id": "a63898e7-a617-42a8-b5c8-5115c42f6720", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/:payment_id/capture", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id", "capture" ], "variable": [ { "id": "cb130286-ee39-4be6-a923-dc1064733b84", "key": "payment_id", "value": "", "description": "(Required) " } ] }, "description": "Updates a payment with the given amount and finalizes it so that it can be paid out in the next nightly settlement batch.\n\n**This endpoint is not rate limited.**\n\nScopes: `PAYMENTS_WRITE`" }, "response": [ { "id": "bae953fc-7c80-4799-9585-e5b4845ef22f", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/:payment_id/capture", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id", "capture" ], "variable": [ { "key": "payment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"net_amount\": \"\",\n \"captured_amount\": \"\",\n \"voided_amount\": \"\",\n \"refunded_amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"capture_before\": \"\",\n \"refund_ids\": [\n \"\",\n \"\"\n ],\n \"reference_id\": \"\",\n \"metadata\": {\n \"aliquipf82\": \"\",\n \"elit6a\": \"\",\n \"sint_b\": \"\",\n \"eiusmod_5\": \"\"\n },\n \"enrichments\": {\n \"initiation\": {\n \"actor\": \"CUSTOMER\"\n },\n \"recurring_series_id\": \"\",\n \"statement_descriptor\": \"\",\n \"restricted_categories\": [\n \"FINANCIAL_SERVICES\",\n \"CANNABIS\"\n ]\n },\n \"decline_errors\": [\n {\n \"category\": \"MERCHANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"BRAND_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"authorization_updates\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"utdd\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"ut_25b\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"BRAND_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"BRAND_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-bae953fc-7c80-4799-9585-e5b4845ef22f" }, { "id": "2d91f392-d565-4731-a11b-9ed347df9713", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/:payment_id/capture", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id", "capture" ], "variable": [ { "key": "payment_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-2d91f392-d565-4731-a11b-9ed347df9713" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-a63898e7-a617-42a8-b5c8-5115c42f6720" } ], "id": "671ea590-3cd3-44d3-a699-8c26f5112587", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-671ea590-3cd3-44d3-a699-8c26f5112587" }, { "name": "void", "item": [ { "name": "Void payment", "id": "164993e4-07b4-4532-b781-55cfea8574d8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/:payment_id/void", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id", "void" ], "variable": [ { "id": "02e65950-0427-4054-a6ce-cf7d9d904536", "key": "payment_id", "value": "", "description": "(Required) " } ] }, "description": "Moves an authorized payment to the voided state and releases the payment authorization from the customer's Cash App account.\n\n \nYou can only void an authorized payment. If a payment is captured, refund it instead. You cannot void any payment that has had an attempted capture. Authorizations not captured within seven days are automatically voided.\n\n\nThis endpoint will return a success message if the payment was successfully voided _or_ if the payment was previously voided.\n\n**This endpoint is not rate limited.**\n\nScopes: `PAYMENTS_WRITE`\n\nPayment voids can be processed synchronously or asynchronously depending on payment type. The majority of voids are made synchronously." }, "response": [ { "id": "8413368c-f557-470f-a2d8-c782994b43bc", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/:payment_id/void", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id", "void" ], "variable": [ { "key": "payment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"net_amount\": \"\",\n \"captured_amount\": \"\",\n \"voided_amount\": \"\",\n \"refunded_amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"status\": \"CAPTURED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"capture_before\": \"\",\n \"refund_ids\": [\n \"\",\n \"\"\n ],\n \"reference_id\": \"\",\n \"metadata\": {\n \"elitb\": \"\"\n },\n \"enrichments\": {\n \"initiation\": {\n \"actor\": \"CUSTOMER\"\n },\n \"recurring_series_id\": \"\",\n \"statement_descriptor\": \"\",\n \"restricted_categories\": [\n \"FINANCIAL_SERVICES\",\n \"ALCOHOL\"\n ]\n },\n \"decline_errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"authorization_updates\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"mollit7e\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"GRANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"dolore_29\": \"\",\n \"aliquipf4\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-8413368c-f557-470f-a2d8-c782994b43bc" }, { "id": "95ee91aa-cbf3-4f30-a88c-c085e32bf79a", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/:payment_id/void", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id", "void" ], "variable": [ { "key": "payment_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-95ee91aa-cbf3-4f30-a88c-c085e32bf79a" }, { "id": "d63eeb9b-1f67-45f1-957d-faa2e7afee17", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/:payment_id/void", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id", "void" ], "variable": [ { "key": "payment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-d63eeb9b-1f67-45f1-957d-faa2e7afee17" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-164993e4-07b4-4532-b781-55cfea8574d8" } ], "id": "e26bd59c-19a5-42e7-bc99-919afb80b44f", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-e26bd59c-19a5-42e7-bc99-919afb80b44f" }, { "name": "Retrieve payment", "id": "da58fc68-a167-4ec7-b5f7-9717e25aa19f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/:payment_id", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id" ], "variable": [ { "id": "4e47db26-ed58-4453-9af3-ddef46ac079a", "key": "payment_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a payment by its ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `PAYMENTS_READ`" }, "response": [ { "id": "dbb20731-f838-44e9-beb5-2e62ba34a086", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/:payment_id", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id" ], "variable": [ { "key": "payment_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"net_amount\": \"\",\n \"captured_amount\": \"\",\n \"voided_amount\": \"\",\n \"refunded_amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"capture_before\": \"\",\n \"refund_ids\": [\n \"\",\n \"\"\n ],\n \"reference_id\": \"\",\n \"metadata\": {\n \"labore_5b\": \"\",\n \"ut3e\": \"\"\n },\n \"enrichments\": {\n \"initiation\": {\n \"actor\": \"MERCHANT\"\n },\n \"recurring_series_id\": \"\",\n \"statement_descriptor\": \"\",\n \"restricted_categories\": [\n \"FINANCIAL_SERVICES\",\n \"ALCOHOL\"\n ]\n },\n \"decline_errors\": [\n {\n \"category\": \"API_KEY_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_KEY_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"authorization_updates\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"occaecat_a\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"DISPUTE_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"voluptate38\": \"\",\n \"ullamcoc5\": \"\",\n \"laboris_f\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"API_KEY_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"BRAND_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-dbb20731-f838-44e9-beb5-2e62ba34a086" }, { "id": "fdf9d111-de65-4528-b393-438bd1852711", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/:payment_id", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_id" ], "variable": [ { "key": "payment_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"GRANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-fdf9d111-de65-4528-b393-438bd1852711" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-da58fc68-a167-4ec7-b5f7-9717e25aa19f" } ], "id": "8ec3c95c-db68-4a4e-a8a4-99ed1d6f8206", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-8ec3c95c-db68-4a4e-a8a4-99ed1d6f8206" }, { "name": "void-by-idempotency-key", "item": [ { "name": "Void payment by idempotency key", "id": "066c8f8d-071b-4ae2-ab8b-477f310172cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/void-by-idempotency-key", "host": [ "{{baseUrl}}" ], "path": [ "payments", "void-by-idempotency-key" ] }, "description": "Moves an authorized payment to the voided state and releases the payment authorization from the customer's Cash App account.\n\n \n You can only void an authorized payment. If a payment is captured, refund the payment instead.\n \n You cannot void any payment that has had an attempted capture. Authorizations not captured within seven days are automatically voided.\n \n\nThis endpoint will return a success message if the payment was successfully voided _or_ if the payment was previously voided.\n\n**This endpoint is not rate limited.**\n\nScopes: `PAYMENTS_WRITE`" }, "response": [ { "id": "bdaf1c86-d1e5-492c-9d1a-d7f0c3db07e0", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/void-by-idempotency-key", "host": [ "{{baseUrl}}" ], "path": [ "payments", "void-by-idempotency-key" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"net_amount\": \"\",\n \"captured_amount\": \"\",\n \"voided_amount\": \"\",\n \"refunded_amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"status\": \"CAPTURED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"capture_before\": \"\",\n \"refund_ids\": [\n \"\",\n \"\"\n ],\n \"reference_id\": \"\",\n \"metadata\": {\n \"ipsuma\": \"\",\n \"in_8e\": \"\"\n },\n \"enrichments\": {\n \"initiation\": {\n \"actor\": \"CUSTOMER\"\n },\n \"recurring_series_id\": \"\",\n \"statement_descriptor\": \"\",\n \"restricted_categories\": [\n \"FINANCIAL_SERVICES\",\n \"FINANCIAL_SERVICES\"\n ]\n },\n \"decline_errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"DISPUTE_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"authorization_updates\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"Ut_64\": \"\",\n \"Lorem92\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"DISPUTE_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_KEY_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"doloref2\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-bdaf1c86-d1e5-492c-9d1a-d7f0c3db07e0" }, { "id": "622080ab-618d-4d80-b39c-18905c4652f0", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments/void-by-idempotency-key", "host": [ "{{baseUrl}}" ], "path": [ "payments", "void-by-idempotency-key" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-622080ab-618d-4d80-b39c-18905c4652f0" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-066c8f8d-071b-4ae2-ab8b-477f310172cc" } ], "id": "d10dbbd7-b354-45cb-a0ae-1b620d6cdc0e", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-d10dbbd7-b354-45cb-a0ae-1b620d6cdc0e" }, { "name": "List payments", "id": "37afc3ab-f2a4-49d4-b27c-171e5fdd8df3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments?cursor=&reference_id=&customer_id=&merchant_id=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "payments" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Filters results to only include payments with a `reference_id` matching the given value.", "key": "reference_id", "value": "" }, { "description": "Filters results to only include payments made by a customer that matches the the given ID.", "key": "customer_id", "value": "" }, { "description": "Filters results to only include payments made to a merchant that matches the the given ID.", "key": "merchant_id", "value": "" }, { "description": "Maximum number of payments to return.", "key": "limit", "value": "50" } ] }, "description": "Returns a list of payments matching the given query parameters.\n\n**This endpoint is rate limited to 100 QPS.**\n\nScopes: `PAYMENTS_READ`" }, "response": [ { "id": "8eb1ae87-7cc4-42bd-acb5-ca12e8f4783e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments?cursor=&reference_id=&customer_id=&merchant_id=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "payments" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Filters results to only include payments with a `reference_id` matching the given value.", "key": "reference_id", "value": "" }, { "description": "Filters results to only include payments made by a customer that matches the the given ID.", "key": "customer_id", "value": "" }, { "description": "Filters results to only include payments made to a merchant that matches the the given ID.", "key": "merchant_id", "value": "" }, { "description": "Maximum number of payments to return.", "key": "limit", "value": "50" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payments\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"net_amount\": \"\",\n \"captured_amount\": \"\",\n \"voided_amount\": \"\",\n \"refunded_amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"capture_before\": \"\",\n \"refund_ids\": [\n \"\",\n \"\"\n ],\n \"reference_id\": \"\",\n \"metadata\": {\n \"sunt_d\": \"\",\n \"anim59\": \"\"\n },\n \"enrichments\": {\n \"initiation\": {\n \"actor\": \"MERCHANT\"\n },\n \"recurring_series_id\": \"\",\n \"statement_descriptor\": \"\",\n \"restricted_categories\": [\n \"CANNABIS\",\n \"FINANCIAL_SERVICES\"\n ]\n },\n \"decline_errors\": [\n {\n \"category\": \"BRAND_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"authorization_updates\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"enim_fa\": \"\",\n \"quis57a\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"GRANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"ex_b\": \"\",\n \"dolord2\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"PAYMENT_PROCESSING_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"net_amount\": \"\",\n \"captured_amount\": \"\",\n \"voided_amount\": \"\",\n \"refunded_amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"capture_before\": \"\",\n \"refund_ids\": [\n \"\",\n \"\"\n ],\n \"reference_id\": \"\",\n \"metadata\": {\n \"consequatb2d\": \"\",\n \"sit4b0\": \"\"\n },\n \"enrichments\": {\n \"initiation\": {\n \"actor\": \"CUSTOMER\"\n },\n \"recurring_series_id\": \"\",\n \"statement_descriptor\": \"\",\n \"restricted_categories\": [\n \"ALCOHOL\",\n \"CANNABIS\"\n ]\n },\n \"decline_errors\": [\n {\n \"category\": \"PAYMENT_PROCESSING_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"PAYMENT_PROCESSING_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"authorization_updates\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"anim5_8\": \"\",\n \"tempor88\": \"\",\n \"ullamco_97\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"GRANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"BRAND_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"veniam__4\": \"\",\n \"et_ff\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"DISPUTE_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-8eb1ae87-7cc4-42bd-acb5-ca12e8f4783e" }, { "id": "b8b6b23d-9efa-4cc1-b901-793ca454cb23", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments?cursor=&reference_id=&customer_id=&merchant_id=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "payments" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Filters results to only include payments with a `reference_id` matching the given value.", "key": "reference_id", "value": "" }, { "description": "Filters results to only include payments made by a customer that matches the the given ID.", "key": "customer_id", "value": "" }, { "description": "Filters results to only include payments made to a merchant that matches the the given ID.", "key": "merchant_id", "value": "" }, { "description": "Maximum number of payments to return.", "key": "limit", "value": "50" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b8b6b23d-9efa-4cc1-b901-793ca454cb23" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-37afc3ab-f2a4-49d4-b27c-171e5fdd8df3" }, { "name": "Create payment", "id": "8ca76bdb-50b6-4244-bb03-fb8bfc7ea17e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"payment\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"reference_id\": \"\",\n \"capture\": true,\n \"metadata\": {\n \"nostrudeda\": \"\",\n \"officia_684\": \"\"\n },\n \"enrichments\": {\n \"initiation\": {\n \"actor\": \"CUSTOMER\"\n },\n \"recurring_series_id\": \"\",\n \"statement_descriptor\": \"\",\n \"restricted_categories\": [\n \"CANNABIS\",\n \"FINANCIAL_SERVICES\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments", "host": [ "{{baseUrl}}" ], "path": [ "payments" ] }, "description": "Creates a payment from a customer to a merchant.\n\n\n\n Creating a payment requires a grant that is associated with the `ON_FILE_PAYMENT` or `ONE_TIME_PAYMENT` actions. To generate a grant, use the Customer Request API.\n\n\n**This endpoint is not rate limited.**\n\nScopes: `PAYMENTS_WRITE`" }, "response": [ { "id": "38a696b4-d517-4e1b-9b6b-ae3d1a739306", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"payment\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"reference_id\": \"\",\n \"capture\": true,\n \"metadata\": {\n \"nostrudeda\": \"\",\n \"officia_684\": \"\"\n },\n \"enrichments\": {\n \"initiation\": {\n \"actor\": \"CUSTOMER\"\n },\n \"recurring_series_id\": \"\",\n \"statement_descriptor\": \"\",\n \"restricted_categories\": [\n \"CANNABIS\",\n \"FINANCIAL_SERVICES\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments", "host": [ "{{baseUrl}}" ], "path": [ "payments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"net_amount\": \"\",\n \"captured_amount\": \"\",\n \"voided_amount\": \"\",\n \"refunded_amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"status\": \"VOIDED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"capture_before\": \"\",\n \"refund_ids\": [\n \"\",\n \"\"\n ],\n \"reference_id\": \"\",\n \"metadata\": {\n \"aute_\": \"\",\n \"minim_f2\": \"\",\n \"occaecat9e\": \"\"\n },\n \"enrichments\": {\n \"initiation\": {\n \"actor\": \"CUSTOMER\"\n },\n \"recurring_series_id\": \"\",\n \"statement_descriptor\": \"\",\n \"restricted_categories\": [\n \"ALCOHOL\",\n \"FINANCIAL_SERVICES\"\n ]\n },\n \"decline_errors\": [\n {\n \"category\": \"GRANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"DISPUTE_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"authorization_updates\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"enim_d2\": \"\",\n \"quib5_\": \"\",\n \"ipsum_9a9\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"BRAND_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"officia_6f\": \"\",\n \"incididunt_79\": \"\",\n \"quis__5\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-38a696b4-d517-4e1b-9b6b-ae3d1a739306" }, { "id": "9125430d-256f-4a0d-8bce-70ba454fcf90", "name": "Bad Request\n\nIf a `PAYMENT_DECLINE_*` error is returned, the payment will still be created, but with a `DECLINED` status. This payment will then appear in the response payload.\n\n \n**`PAYMENT_DECLINE_*` errors consume one-time use grants.**\n This mea", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"payment\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"reference_id\": \"\",\n \"capture\": true,\n \"metadata\": {\n \"nostrudeda\": \"\",\n \"officia_684\": \"\"\n },\n \"enrichments\": {\n \"initiation\": {\n \"actor\": \"CUSTOMER\"\n },\n \"recurring_series_id\": \"\",\n \"statement_descriptor\": \"\",\n \"restricted_categories\": [\n \"CANNABIS\",\n \"FINANCIAL_SERVICES\"\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments", "host": [ "{{baseUrl}}" ], "path": [ "payments" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"API_KEY_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_KEY_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"payment\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"net_amount\": \"\",\n \"captured_amount\": \"\",\n \"voided_amount\": \"\",\n \"refunded_amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"capture_before\": \"\",\n \"refund_ids\": [\n \"\",\n \"\"\n ],\n \"reference_id\": \"\",\n \"metadata\": {\n \"dolor19\": \"\"\n },\n \"enrichments\": {\n \"initiation\": {\n \"actor\": \"MERCHANT\"\n },\n \"recurring_series_id\": \"\",\n \"statement_descriptor\": \"\",\n \"restricted_categories\": [\n \"ALCOHOL\",\n \"ALCOHOL\"\n ]\n },\n \"decline_errors\": [\n {\n \"category\": \"GRANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"authorization_updates\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"reprehenderitd00\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"PAYMENT_PROCESSING_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"\",\n \"payment_id\": \"\",\n \"previous_amount\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"esse75\": \"\",\n \"laborum_d\": \"\",\n \"nostrud_9\": \"\",\n \"consecteturc3\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"BRAND_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-9125430d-256f-4a0d-8bce-70ba454fcf90" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-8ca76bdb-50b6-4244-bb03-fb8bfc7ea17e" } ], "id": "155ea6f1-21ef-4768-9ea9-a666110fb515", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-155ea6f1-21ef-4768-9ea9-a666110fb515" }, { "name": "payouts", "item": [ { "name": "{payout_id}", "item": [ { "name": "Retrieve payout", "id": "80c8d1ab-9429-433f-b710-dd9ecea8cdc6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payouts/:payout_id", "host": [ "{{baseUrl}}" ], "path": [ "payouts", ":payout_id" ], "variable": [ { "id": "83c1c69e-6d79-4aac-8118-048de2d0ecb3", "key": "payout_id", "value": "", "description": "(Required) " } ] }, "description": "\nPayouts is an **early access** feature. We're actively improving this API based on your feedback.\n\nEarly access features come with some caveats:\n\n* May evolve rapidly, requiring integration updates\n* Not subject to our 10 year version support policy\n* Not subject to SLAs (unless specified in a contract)\n\n\nRetrieves a payout by its ID.\n\n**This endpoint is not rate-limited.**\n\nScopes: `PAYOUTS_READ`" }, "response": [ { "id": "9383ead0-eb10-4627-843b-b0d73a475968", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payouts/:payout_id", "host": [ "{{baseUrl}}" ], "path": [ "payouts", ":payout_id" ], "variable": [ { "key": "payout_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payout\": {\n \"payout_id\": \"\",\n \"grant_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"merchant_id\": \"\",\n \"purpose\": \"SERVICES\",\n \"customer_id\": \"\",\n \"authorized_amount\": \"\",\n \"captured_amount\": \"\",\n \"declined_amount\": \"\",\n \"voided_amount\": \"\",\n \"reference_id\": \"\",\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"note\": \"\",\n \"metadata\": {\n \"minim4_9\": \"\",\n \"proident85e\": \"\",\n \"officia_08\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"DISPUTE_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-9383ead0-eb10-4627-843b-b0d73a475968" }, { "id": "223e5b9d-89b6-476c-b13b-a6e5214c9ce4", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payouts/:payout_id", "host": [ "{{baseUrl}}" ], "path": [ "payouts", ":payout_id" ], "variable": [ { "key": "payout_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_KEY_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-223e5b9d-89b6-476c-b13b-a6e5214c9ce4" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-80c8d1ab-9429-433f-b710-dd9ecea8cdc6" } ], "id": "ad3e895c-236e-4016-979a-fe41de60011d", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-ad3e895c-236e-4016-979a-fe41de60011d" }, { "name": "List payouts", "id": "6e3d2231-5a44-4d20-a036-74bf4395d7b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payouts?cursor=&merchant_id=&customer_id=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "payouts" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Filters results to include only payouts made to a merchant that matches the given ID.", "key": "merchant_id", "value": "" }, { "description": "Filters results to include only payouts made to a customer that matches the given ID.", "key": "customer_id", "value": "" }, { "description": "Maximum number of payouts to return.", "key": "limit", "value": "50" } ] }, "description": "\nPayouts is an **early access** feature. We're actively improving this API based on your feedback.\n\nEarly access features come with some caveats:\n\n* May evolve rapidly, requiring integration updates\n* Not subject to our 10 year version support policy\n* Not subject to SLAs (unless specified in a contract)\n\n\nReturns a list of payouts matching the given query parameters.\n\n**This endpoint is rate limited to 100 QPS.**\n\nScopes: `PAYOUTS_READ`" }, "response": [ { "id": "915644a7-47fc-4ee3-8b73-cd4b68003b54", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payouts?cursor=&merchant_id=&customer_id=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "payouts" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Filters results to include only payouts made to a merchant that matches the given ID.", "key": "merchant_id", "value": "" }, { "description": "Filters results to include only payouts made to a customer that matches the given ID.", "key": "customer_id", "value": "" }, { "description": "Maximum number of payouts to return.", "key": "limit", "value": "50" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payouts\": [\n {\n \"payout_id\": \"\",\n \"grant_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"DECLINED\",\n \"merchant_id\": \"\",\n \"purpose\": \"SERVICES\",\n \"customer_id\": \"\",\n \"authorized_amount\": \"\",\n \"captured_amount\": \"\",\n \"declined_amount\": \"\",\n \"voided_amount\": \"\",\n \"reference_id\": \"\",\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"note\": \"\",\n \"metadata\": {\n \"fugiat9__\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n },\n {\n \"payout_id\": \"\",\n \"grant_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"AUTHORIZED\",\n \"merchant_id\": \"\",\n \"purpose\": \"SERVICES\",\n \"customer_id\": \"\",\n \"authorized_amount\": \"\",\n \"captured_amount\": \"\",\n \"declined_amount\": \"\",\n \"voided_amount\": \"\",\n \"reference_id\": \"\",\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"note\": \"\",\n \"metadata\": {\n \"nisi_3af\": \"\",\n \"ea_d\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"MERCHANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_KEY_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-915644a7-47fc-4ee3-8b73-cd4b68003b54" }, { "id": "080a0503-87a7-4adb-a1a9-3c694c490e38", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payouts?cursor=&merchant_id=&customer_id=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "payouts" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Filters results to include only payouts made to a merchant that matches the given ID.", "key": "merchant_id", "value": "" }, { "description": "Filters results to include only payouts made to a customer that matches the given ID.", "key": "customer_id", "value": "" }, { "description": "Maximum number of payouts to return.", "key": "limit", "value": "50" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-080a0503-87a7-4adb-a1a9-3c694c490e38" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-6e3d2231-5a44-4d20-a036-74bf4395d7b8" }, { "name": "Create payout", "id": "5819aa74-f85e-4965-96d0-41b8a9cfee9b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"payout\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"purpose\": \"SERVICES\",\n \"capture\": true,\n \"note\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"consequat_f8\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payouts", "host": [ "{{baseUrl}}" ], "path": [ "payouts" ] }, "description": "\nPayouts is an **early access** feature. We're actively improving this API based on your feedback.\n\nEarly access features come with some caveats:\n\n* May evolve rapidly, requiring integration updates\n* Not subject to our 10 year version support policy\n* Not subject to SLAs (unless specified in a contract)\n\n\nCreates a payout to a customer. A payout allows a merchant to send money to a customer's Cash App account.\n\n**This endpoint is not rate-limited.**\n\nScopes: `PAYOUTS_WRITE`" }, "response": [ { "id": "a5a10418-e08f-45b6-9c0f-ab1abbcae911", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"payout\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"purpose\": \"SERVICES\",\n \"capture\": true,\n \"note\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"consequat_f8\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payouts", "host": [ "{{baseUrl}}" ], "path": [ "payouts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payout\": {\n \"payout_id\": \"\",\n \"grant_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"AUTHORIZED\",\n \"merchant_id\": \"\",\n \"purpose\": \"SERVICES\",\n \"customer_id\": \"\",\n \"authorized_amount\": \"\",\n \"captured_amount\": \"\",\n \"declined_amount\": \"\",\n \"voided_amount\": \"\",\n \"reference_id\": \"\",\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"note\": \"\",\n \"metadata\": {\n \"voluptate_f9\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"API_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-a5a10418-e08f-45b6-9c0f-ab1abbcae911" }, { "id": "7cf662c6-5800-4a90-bf5d-573ab5467f03", "name": "Bad Request\n\nIf a `PAYOUT_DECLINE_*` error is returned, the payout will still be created, but with a `DECLINED` status. This payout will then appear in the response payload.\n\n\n**`PAYOUT_DECLINE_*` errors consume one-time use grants.**\n This means yo", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"payout\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_id\": \"\",\n \"grant_id\": \"\",\n \"purpose\": \"SERVICES\",\n \"capture\": true,\n \"note\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"consequat_f8\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payouts", "host": [ "{{baseUrl}}" ], "path": [ "payouts" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"API_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"payout\": {\n \"payout_id\": \"\",\n \"grant_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"status\": \"INITIATED\",\n \"merchant_id\": \"\",\n \"purpose\": \"SERVICES\",\n \"customer_id\": \"\",\n \"authorized_amount\": \"\",\n \"captured_amount\": \"\",\n \"declined_amount\": \"\",\n \"voided_amount\": \"\",\n \"reference_id\": \"\",\n \"fee_amount\": \"\",\n \"fee_rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"note\": \"\",\n \"metadata\": {\n \"in3ca\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"GRANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-7cf662c6-5800-4a90-bf5d-573ab5467f03" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-5819aa74-f85e-4965-96d0-41b8a9cfee9b" } ], "id": "22d52bc6-7a4e-4b10-ba7f-4888ba33f4cf", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-22d52bc6-7a4e-4b10-ba7f-4888ba33f4cf" }, { "name": "balances", "item": [ { "name": "{balance_id}", "item": [ { "name": "Retrieve balance", "id": "e6e992f5-8e68-4fdd-b80e-cef0b8bb9f4f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/balances/:balance_id?grant_id=", "host": [ "{{baseUrl}}" ], "path": [ "balances", ":balance_id" ], "query": [ { "description": "ID of the grant that authorizes reading the customer's balances. This grant is created when a customer approves a `CHECKING_BALANCE` action in the Customer Request API.", "key": "grant_id", "value": "" } ], "variable": [ { "id": "7222243f-4282-40ff-9b90-883e8cc9b54f", "key": "balance_id", "value": "", "description": "(Required) " } ] }, "description": "\nBalances is a **beta** feature. We're actively improving this API based on your feedback.\n\n\nRetrieves a balance by its ID.\n\nScopes: `BALANCES_READ`" }, "response": [ { "id": "8e6c8a54-8046-4e52-8a64-b7877a8fbea8", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/balances/:balance_id?grant_id=", "host": [ "{{baseUrl}}" ], "path": [ "balances", ":balance_id" ], "query": [ { "description": "ID of the grant that authorizes reading the customer's balances. This grant is created when a customer approves a `CHECKING_BALANCE` action in the Customer Request API.", "key": "grant_id", "value": "" } ], "variable": [ { "key": "balance_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"balance\": {\n \"id\": \"\",\n \"customer_id\": \"\",\n \"type\": \"CHECKING\",\n \"currency\": \"USD\",\n \"amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-8e6c8a54-8046-4e52-8a64-b7877a8fbea8" }, { "id": "0bb67dc4-03cc-4199-9f9d-73a09522b038", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/balances/:balance_id?grant_id=", "host": [ "{{baseUrl}}" ], "path": [ "balances", ":balance_id" ], "query": [ { "description": "ID of the grant that authorizes reading the customer's balances. This grant is created when a customer approves a `CHECKING_BALANCE` action in the Customer Request API.", "key": "grant_id", "value": "" } ], "variable": [ { "key": "balance_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"API_KEY_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-0bb67dc4-03cc-4199-9f9d-73a09522b038" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-e6e992f5-8e68-4fdd-b80e-cef0b8bb9f4f" } ], "id": "758f3f78-7dda-414e-81bd-4f648b6fd653", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-758f3f78-7dda-414e-81bd-4f648b6fd653" }, { "name": "List balances", "id": "b3e462d3-8822-40a2-b340-7f60a6ccfb03", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/balances?customer_id=&type=CHECKING&grant_id=&cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "balances" ], "query": [ { "description": "(Required) ID of the customer whose balances will be listed.", "key": "customer_id", "value": "" }, { "description": "(Required) The type of balances to list.", "key": "type", "value": "CHECKING" }, { "description": "ID of the grant that authorizes reading the customer's balances. This grant is created when a customer approves a `CHECKING_BALANCE` action in the Customer Request API.", "key": "grant_id", "value": "" }, { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of balances to return.", "key": "limit", "value": "50" } ] }, "description": "\nBalances is a **beta** feature. We're actively improving this API based on your feedback.\n\n\nReturns a list of balances for a customer matching the given query parameters.\n\nScopes: `BALANCES_READ`" }, "response": [ { "id": "6320ac16-f1fd-495d-8ad8-a4ca053d793b", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/balances?customer_id=&type=CHECKING&grant_id=&cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "balances" ], "query": [ { "description": "(Required) ID of the customer whose balances will be listed.", "key": "customer_id", "value": "" }, { "description": "(Required) The type of balances to list.", "key": "type", "value": "CHECKING" }, { "description": "ID of the grant that authorizes reading the customer's balances. This grant is created when a customer approves a `CHECKING_BALANCE` action in the Customer Request API.", "key": "grant_id", "value": "" }, { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of balances to return.", "key": "limit", "value": "50" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"balances\": [\n {\n \"id\": \"\",\n \"customer_id\": \"\",\n \"type\": \"CHECKING\",\n \"currency\": \"USD\",\n \"amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"customer_id\": \"\",\n \"type\": \"CHECKING\",\n \"currency\": \"USD\",\n \"amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-6320ac16-f1fd-495d-8ad8-a4ca053d793b" }, { "id": "4d2f8755-c1e9-40ca-8c71-d6497e863300", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/balances?customer_id=&type=CHECKING&grant_id=&cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "balances" ], "query": [ { "description": "(Required) ID of the customer whose balances will be listed.", "key": "customer_id", "value": "" }, { "description": "(Required) The type of balances to list.", "key": "type", "value": "CHECKING" }, { "description": "ID of the grant that authorizes reading the customer's balances. This grant is created when a customer approves a `CHECKING_BALANCE` action in the Customer Request API.", "key": "grant_id", "value": "" }, { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of balances to return.", "key": "limit", "value": "50" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-4d2f8755-c1e9-40ca-8c71-d6497e863300" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b3e462d3-8822-40a2-b340-7f60a6ccfb03" } ], "id": "adb92180-dde1-4efe-a0ea-e8e20b151780", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-adb92180-dde1-4efe-a0ea-e8e20b151780" }, { "name": "refunds", "item": [ { "name": "{refund_id}", "item": [ { "name": "capture", "item": [ { "name": "Capture refund", "id": "714ffd6d-4844-4801-bc75-9925ef098ebb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/refunds/:refund_id/capture", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refund_id", "capture" ], "variable": [ { "id": "c5db4c1d-30b3-483f-bbc3-e4e71d9efca7", "key": "refund_id", "value": "", "description": "(Required) " } ] }, "description": "Finalizes a refund so that it can be allocated in the next nightly settlement batch.\n\n**This endpoint is not rate limited.**\n\nScopes: `REFUNDS_WRITE`" }, "response": [ { "id": "2664231b-0e11-4917-b4be-a14c472d6b02", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/refunds/:refund_id/capture", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refund_id", "capture" ], "variable": [ { "key": "refund_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"refund\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grant_id\": \"\",\n \"payment_id\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"in_41a\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"PAYMENT_PROCESSING_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-2664231b-0e11-4917-b4be-a14c472d6b02" }, { "id": "6f0a6691-e262-42f7-8bbb-c935bcd24872", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/refunds/:refund_id/capture", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refund_id", "capture" ], "variable": [ { "key": "refund_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-6f0a6691-e262-42f7-8bbb-c935bcd24872" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-714ffd6d-4844-4801-bc75-9925ef098ebb" } ], "id": "b23c7ee3-353a-465d-8f4e-46017eb06b0c", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b23c7ee3-353a-465d-8f4e-46017eb06b0c" }, { "name": "void", "item": [ { "name": "Void refund", "id": "b83372df-1301-405b-8d0b-d81857039339", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/refunds/:refund_id/void", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refund_id", "void" ], "variable": [ { "id": "574a4fcf-84dd-4446-b7ba-8e58a514bff7", "key": "refund_id", "value": "", "description": "(Required) " } ] }, "description": "Moves an authorized refund to the voided state and removes the \"pending refund\" screen from a customer's Cash App account.\n\n \nYou can only void an authorized refund.\n\n\n**This endpoint is not rate limited.**\n\nScopes: `REFUNDS_WRITE`" }, "response": [ { "id": "defd347d-d880-4e57-9acc-ec4e4a1a7c5a", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/refunds/:refund_id/void", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refund_id", "void" ], "variable": [ { "key": "refund_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"refund\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"status\": \"CAPTURED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grant_id\": \"\",\n \"payment_id\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"irure2d\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"PAYMENT_PROCESSING_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-defd347d-d880-4e57-9acc-ec4e4a1a7c5a" }, { "id": "7525f56d-4cd9-42bb-acf7-d65b69bbae6e", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/refunds/:refund_id/void", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refund_id", "void" ], "variable": [ { "key": "refund_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-7525f56d-4cd9-42bb-acf7-d65b69bbae6e" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b83372df-1301-405b-8d0b-d81857039339" } ], "id": "72afb337-44db-47e1-b3eb-79a8294d646f", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-72afb337-44db-47e1-b3eb-79a8294d646f" }, { "name": "Retrieve refund", "id": "e4af92d7-7ec5-424e-838a-ba9b0b0cdc60", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/refunds/:refund_id", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refund_id" ], "variable": [ { "id": "e8c505e3-2b52-4228-852e-4590ae231e75", "key": "refund_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a refund by its ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `REFUNDS_READ`" }, "response": [ { "id": "391a3a9e-0c9d-493b-9d0e-c1a1abf93427", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/refunds/:refund_id", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refund_id" ], "variable": [ { "key": "refund_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"refund\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"status\": \"VOIDED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grant_id\": \"\",\n \"payment_id\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"consequat9d\": \"\",\n \"irure_b\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"PAYMENT_PROCESSING_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-391a3a9e-0c9d-493b-9d0e-c1a1abf93427" }, { "id": "d68194c4-f1a5-4240-a94a-c066bdd87e61", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/refunds/:refund_id", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refund_id" ], "variable": [ { "key": "refund_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-d68194c4-f1a5-4240-a94a-c066bdd87e61" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-e4af92d7-7ec5-424e-838a-ba9b0b0cdc60" } ], "id": "e314eada-5389-4dd2-93aa-df1065cfc7eb", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-e314eada-5389-4dd2-93aa-df1065cfc7eb" }, { "name": "void-by-idempotency-key", "item": [ { "name": "Void refund by idempotency key", "id": "f6a831c5-dfab-45f9-86e7-182549471d4b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/refunds/void-by-idempotency-key", "host": [ "{{baseUrl}}" ], "path": [ "refunds", "void-by-idempotency-key" ] }, "description": "Moves an authorized refund to the voided state using the idempotency key specified while creating the refund.\n\n \nYou can only void an authorized refund. If a refund is captured, there is no way to reverse it.\n\n\nIn rare cases, an issue with an integration, network connectivity, or the Cash App Pay API may cause an API client to end up in a state where a refund is created in Cash App Pay, but the API client doesn't know the ID of the refund. This endpoint allows an API client to void a refund using _only_ the idempotency key to recover from these situations.\n\nIf you don't have the idempotency key or ID of the refund you want to void, you can use the [list refunds](Network-API.v1.yaml/paths/~1refunds/get) endpoint to try to search for the refund you're looking for.\n\n**This endpoint is not rate limited.**\n\nScopes: `REFUNDS_WRITE`" }, "response": [ { "id": "e2348de7-13f3-4d06-b9d8-6fc3bb78ab50", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/refunds/void-by-idempotency-key", "host": [ "{{baseUrl}}" ], "path": [ "refunds", "void-by-idempotency-key" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"refund\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grant_id\": \"\",\n \"payment_id\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"tempor_f_\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"GRANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-e2348de7-13f3-4d06-b9d8-6fc3bb78ab50" }, { "id": "b9aea3e0-0da4-4453-98a2-64f001ec3b55", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/refunds/void-by-idempotency-key", "host": [ "{{baseUrl}}" ], "path": [ "refunds", "void-by-idempotency-key" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b9aea3e0-0da4-4453-98a2-64f001ec3b55" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-f6a831c5-dfab-45f9-86e7-182549471d4b" } ], "id": "aab03ed4-b314-41f6-a574-204f2215a220", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-aab03ed4-b314-41f6-a574-204f2215a220" }, { "name": "List refunds", "id": "0713ed45-a537-4397-899c-dc0337d67999", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/refunds?cursor=&reference_id=&customer_id=&merchant_id=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "refunds" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Filters results to only include refunds with a `reference_id` matching the given value.", "key": "reference_id", "value": "" }, { "description": "Filters results to only include refunds made to a customer that matches the the given ID.", "key": "customer_id", "value": "" }, { "description": "Filters results to only include refunds made by a merchant that matches the given ID.", "key": "merchant_id", "value": "" }, { "description": "Maximum number of refunds to return.", "key": "limit", "value": "50" } ] }, "description": "Returns a list of refunds matching the given query parameters.\n\n**This endpoint is rate limited to 100 QPS.**\n\nScopes: `REFUNDS_READ`" }, "response": [ { "id": "f9f81da7-c50c-4c2d-bdc8-2d6a1e3fe717", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/refunds?cursor=&reference_id=&customer_id=&merchant_id=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "refunds" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Filters results to only include refunds with a `reference_id` matching the given value.", "key": "reference_id", "value": "" }, { "description": "Filters results to only include refunds made to a customer that matches the the given ID.", "key": "customer_id", "value": "" }, { "description": "Filters results to only include refunds made by a merchant that matches the given ID.", "key": "merchant_id", "value": "" }, { "description": "Maximum number of refunds to return.", "key": "limit", "value": "50" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"refunds\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"status\": \"AUTHORIZED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grant_id\": \"\",\n \"payment_id\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"irure4\": \"\",\n \"consequata\": \"\",\n \"ullamcoc7\": \"\",\n \"est9\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"PAYMENT_PROCESSING_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"PAYMENT_PROCESSING_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"status\": \"DECLINED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grant_id\": \"\",\n \"payment_id\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"exercitation_2c\": \"\",\n \"ade3a\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"INVALID_REQUEST_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"MERCHANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-f9f81da7-c50c-4c2d-bdc8-2d6a1e3fe717" }, { "id": "feda1d2e-e88d-4770-a51a-e2c116a09e7e", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/refunds?cursor=&reference_id=&customer_id=&merchant_id=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "refunds" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Filters results to only include refunds with a `reference_id` matching the given value.", "key": "reference_id", "value": "" }, { "description": "Filters results to only include refunds made to a customer that matches the the given ID.", "key": "customer_id", "value": "" }, { "description": "Filters results to only include refunds made by a merchant that matches the given ID.", "key": "merchant_id", "value": "" }, { "description": "Maximum number of refunds to return.", "key": "limit", "value": "50" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-feda1d2e-e88d-4770-a51a-e2c116a09e7e" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-0713ed45-a537-4397-899c-dc0337d67999" }, { "name": "Create refund", "id": "3aa3ce24-3ac5-4567-8b32-67911e65a2dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"refund\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_id\": \"\",\n \"payment_id\": \"\",\n \"capture\": true,\n \"reference_id\": \"\",\n \"metadata\": {\n \"exercitation_e11\": \"\",\n \"in_37\": \"\",\n \"eiusmode25\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/refunds", "host": [ "{{baseUrl}}" ], "path": [ "refunds" ] }, "description": "Creates a refund from a merchant to a customer.\n\n- To issue a refund, provide a `payment_id` in the request. \n\nThe grant must be associated with the `ON_FILE_PAYMENT` actions.\n\nTo generate a grant to pass to this field, use the Customer Request API.\n\n**This endpoint is not rate limited.**\n\nScopes: `REFUNDS_WRITE`" }, "response": [ { "id": "4fad4c93-4bd4-4e54-a1ea-5b028e834599", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"refund\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_id\": \"\",\n \"payment_id\": \"\",\n \"capture\": true,\n \"reference_id\": \"\",\n \"metadata\": {\n \"exercitation_e11\": \"\",\n \"in_37\": \"\",\n \"eiusmode25\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/refunds", "host": [ "{{baseUrl}}" ], "path": [ "refunds" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"refund\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"status\": \"CAPTURED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grant_id\": \"\",\n \"payment_id\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"incididunt27\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-4fad4c93-4bd4-4e54-a1ea-5b028e834599" }, { "id": "4c5ae3d9-e6e5-408e-bced-8de64c646ae4", "name": "Bad Request\n\nIf a `REFUND_DECLINE_*` error is returned, the refund will still be created, but with a `DECLINED` status. This refund will then appear in the response payload.\n\n \n**`REFUND_DECLINE_*` errors consume one-time use grants.**\n This means y", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"refund\": {\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"merchant_id\": \"\",\n \"payment_id\": \"\",\n \"capture\": true,\n \"reference_id\": \"\",\n \"metadata\": {\n \"exercitation_e11\": \"\",\n \"in_37\": \"\",\n \"eiusmode25\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/refunds", "host": [ "{{baseUrl}}" ], "path": [ "refunds" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"PAYMENT_PROCESSING_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"GRANT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ],\n \"refund\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"currency\": \"USD\",\n \"customer_id\": \"\",\n \"merchant_id\": \"\",\n \"status\": \"VOIDED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grant_id\": \"\",\n \"payment_id\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"consectetur_3d\": \"\",\n \"dolor__\": \"\",\n \"ametb7\": \"\"\n },\n \"decline_errors\": [\n {\n \"category\": \"API_KEY_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"AUTHENTICATION_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-4c5ae3d9-e6e5-408e-bced-8de64c646ae4" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-3aa3ce24-3ac5-4567-8b32-67911e65a2dc" } ], "id": "3ab93495-4b7e-46f4-9b8a-a8b6f6580f25", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-3ab93495-4b7e-46f4-9b8a-a8b6f6580f25" }, { "name": "disputes", "item": [ { "name": "{dispute_id}", "item": [ { "name": "accept", "item": [ { "name": "Accept dispute", "id": "b7c04062-6f57-4946-bd79-9316af1a8405", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/accept", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "accept" ], "variable": [ { "id": "c0f6685e-8837-428d-9bb6-948022b3017e", "key": "dispute_id", "value": "", "description": "(Required) " } ] }, "description": "Resolves a dispute by having the merchant accept responsibility for it. This leads to a \"loss\" of the dispute from the merchant's perspective, and a \"win\" of the dispute from the customer's perspective.\n\n \nAfter a dispute is accepted, the decision is final; it can never be changed.\n\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_WRITE`" }, "response": [ { "id": "1c66e16d-993b-4976-b267-d6678bde47b6", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/accept", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "accept" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"dispute\": {\n \"id\": \"\",\n \"payment_id\": \"\",\n \"amount\": \"\",\n \"reason\": \"PE11\",\n \"settlement_withholding\": \"WITHHELD_ALREADY\",\n \"state\": \"PROCESSING\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"merchant_id\": \"\",\n \"customer_credited_amount\": \"\",\n \"response_due_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-1c66e16d-993b-4976-b267-d6678bde47b6" }, { "id": "a267d432-12b8-4064-8df7-060f2191750d", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/accept", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "accept" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-a267d432-12b8-4064-8df7-060f2191750d" }, { "id": "20806907-caca-481a-bb08-33a6ea6d9c33", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/accept", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "accept" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-20806907-caca-481a-bb08-33a6ea6d9c33" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b7c04062-6f57-4946-bd79-9316af1a8405" } ], "id": "fa7a9f37-ca47-43bf-bfb6-9ca3c82cee07", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-fa7a9f37-ca47-43bf-bfb6-9ca3c82cee07" }, { "name": "challenge", "item": [ { "name": "Challenge dispute", "id": "948cc24e-50d4-4c59-bcff-f7ab4fe19ab2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/challenge", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "challenge" ], "variable": [ { "id": "dbbfa27e-a91c-4539-8976-937dc5351fce", "key": "dispute_id", "value": "", "description": "(Required) " } ] }, "description": "Submits evidence uploaded to this dispute to Cash App Pay for review.\n\nAfter Cash App Pay reviews the dispute, a final decision will be reached and funds will be settled appropriately. If this endpoint is not called by the `response_due_at` timestamp, the merchant will automatically \"lose\" the dispute.\n\n \nChallenging a dispute does not guarantee that the merchant will \"win\" it. It only means that it will be reviewed, instead of being automatically accepted by the merchant.\n\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_WRITE`" }, "response": [ { "id": "c5f1863d-e233-40b7-b4d4-e6fcf3255dfc", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/challenge", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "challenge" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"dispute\": {\n \"id\": \"\",\n \"payment_id\": \"\",\n \"amount\": \"\",\n \"reason\": \"CD10\",\n \"settlement_withholding\": \"NOT_WITHHELD\",\n \"state\": \"RESPONSE_REQUIRED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"merchant_id\": \"\",\n \"customer_credited_amount\": \"\",\n \"response_due_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-c5f1863d-e233-40b7-b4d4-e6fcf3255dfc" }, { "id": "e76fd44a-68bc-4695-bf61-a63576f398ee", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/challenge", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "challenge" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-e76fd44a-68bc-4695-bf61-a63576f398ee" }, { "id": "5f863d0b-e0eb-45ee-ad94-470bac83d82a", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/challenge", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "challenge" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-5f863d0b-e0eb-45ee-ad94-470bac83d82a" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-948cc24e-50d4-4c59-bcff-f7ab4fe19ab2" } ], "id": "74147536-42a7-4401-9983-3136f2cf51ea", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-74147536-42a7-4401-9983-3136f2cf51ea" }, { "name": "evidence", "item": [ { "name": "{evidence_id}", "item": [ { "name": "Delete dispute evidence", "id": "0f628168-c7f2-4ca4-aa6f-7fd1455d7628", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence/:evidence_id", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence", ":evidence_id" ], "variable": [ { "id": "c5bd8a4d-e5ae-4eb3-ae4c-362c165ab87b", "key": "dispute_id", "value": "", "description": "(Required) " }, { "id": "5788ae2d-30e1-4bc7-912c-728eb84a39cb", "key": "evidence_id", "value": "", "description": "(Required) " } ] }, "description": "Deletes a piece of dispute evidence by the ID of the dispute its for and its own ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_WRITE`" }, "response": [ { "id": "7a8f2c15-b24e-4bcc-b27b-2d18d8372d40", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence/:evidence_id", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence", ":evidence_id" ], "variable": [ { "key": "dispute_id" }, { "key": "evidence_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-7a8f2c15-b24e-4bcc-b27b-2d18d8372d40" }, { "id": "d8b95dd5-10d1-429d-ba6a-19e6b3d1deea", "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence/:evidence_id", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence", ":evidence_id" ], "variable": [ { "key": "dispute_id" }, { "key": "evidence_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-d8b95dd5-10d1-429d-ba6a-19e6b3d1deea" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-0f628168-c7f2-4ca4-aa6f-7fd1455d7628" }, { "name": "Retrieve dispute evidence", "id": "2e4b5526-0e78-4a5b-9887-e02faa0aad29", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence/:evidence_id", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence", ":evidence_id" ], "variable": [ { "id": "85c016d5-7e8f-4390-8964-9f6c65aaf292", "key": "dispute_id", "value": "", "description": "(Required) " }, { "id": "beb44b6d-9d61-40ad-9374-a192c803b044", "key": "evidence_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a piece of dispute evidence by the ID of the dispute its for and its own ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_READ`" }, "response": [ { "id": "8c078df4-954c-4179-90cd-7bd5812af438", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence/:evidence_id", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence", ":evidence_id" ], "variable": [ { "key": "dispute_id" }, { "key": "evidence_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"evidence\": {\n \"id\": \"\",\n \"dispute_id\": \"\",\n \"category\": \"RELATED_TRANSACTION_DOCUMENTATION\",\n \"type\": \"FILE\",\n \"created_at\": \"\",\n \"file\": {\n \"filename\": \"\",\n \"content_type\": \"application/pdf\"\n },\n \"text\": \"\",\n \"metadata\": {\n \"Lorem_351\": \"\",\n \"fugiat_c3b\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-8c078df4-954c-4179-90cd-7bd5812af438" }, { "id": "0168c78a-b66b-4e8c-a0cc-ae47bf4b983a", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence/:evidence_id", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence", ":evidence_id" ], "variable": [ { "key": "dispute_id" }, { "key": "evidence_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-0168c78a-b66b-4e8c-a0cc-ae47bf4b983a" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-2e4b5526-0e78-4a5b-9887-e02faa0aad29" } ], "id": "ff04ae53-12eb-41f1-96cc-0736ac41853f", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-ff04ae53-12eb-41f1-96cc-0736ac41853f" }, { "name": "List dispute evidence", "id": "85c8b7b5-34d4-4665-a576-081e33ae7c49", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence?cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of pieces of dispute evidence to return", "key": "limit", "value": "50" } ], "variable": [ { "id": "7ccfa727-318a-43db-840b-fffbcf888e54", "key": "dispute_id", "value": "", "description": "(Required) " } ] }, "description": "Returns a list of all pieces of evidence associated with the given dispute.\n\n**This endpoint is rate limited to 50 QPS.**\n\nScopes: `DISPUTES_READ`" }, "response": [ { "id": "e986b5e8-d8d1-4d91-a849-ecd82dd25ff6", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence?cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of pieces of dispute evidence to return", "key": "limit", "value": "50" } ], "variable": [ { "key": "dispute_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"evidence\": [\n {\n \"id\": \"\",\n \"dispute_id\": \"\",\n \"category\": \"DUPLICATE_CHARGE_DOCUMENTATION\",\n \"type\": \"TEXT\",\n \"created_at\": \"\",\n \"file\": {\n \"filename\": \"\",\n \"content_type\": \"application/pdf\"\n },\n \"text\": \"\",\n \"metadata\": {\n \"dolore9f\": \"\",\n \"pariatur_8\": \"\",\n \"exfa\": \"\",\n \"non845\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"dispute_id\": \"\",\n \"category\": \"PURCHASE_ACKNOWLEDGEMENT\",\n \"type\": \"TEXT\",\n \"created_at\": \"\",\n \"file\": {\n \"filename\": \"\",\n \"content_type\": \"application/pdf\"\n },\n \"text\": \"\",\n \"metadata\": {\n \"tempor50\": \"\",\n \"nulla_8d\": \"\"\n }\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-e986b5e8-d8d1-4d91-a849-ecd82dd25ff6" }, { "id": "bc9b9c3b-c7d1-4d1f-b4a7-531223189e37", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence?cursor=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of pieces of dispute evidence to return", "key": "limit", "value": "50" } ], "variable": [ { "key": "dispute_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-bc9b9c3b-c7d1-4d1f-b4a7-531223189e37" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-85c8b7b5-34d4-4665-a576-081e33ae7c49" } ], "id": "563a62f6-61c6-4e4f-8293-6ac6885e8cfe", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-563a62f6-61c6-4e4f-8293-6ac6885e8cfe" }, { "name": "evidence-text", "item": [ { "name": "Create dispute evidence text", "id": "b93d84ca-9d64-4789-bf60-a6c26de32e43", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"evidence\": {\n \"category\": \"RELATED_TRANSACTION_DOCUMENTATION\",\n \"text\": \"\",\n \"metadata\": {\n \"in_81b\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence-text", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence-text" ], "variable": [ { "id": "28342c3d-d3c3-4be2-acac-55021184f76b", "key": "dispute_id", "value": "", "description": "(Required) " } ] }, "description": "Creates a piece of evidence for the given dispute from a blob of plain text, which can then be submitted with the [challenge dispute](Network-API.v1.yaml/paths/~1disputes~1{dispute_id}~1challenge) endpoint.\n\nIf you have more than 500 characters of text to submit as evidence, split it into multiple pieces where possible.\n\n \nUploading evidence does not challenge the dispute. Make sure to call the [challenge dispute](Network-API.v1.yaml/paths/~1disputes~1{dispute_id}~1challenge) endpoint before the `response_due_at` timestamp, or else the merchant will automatically \"lose\" the dispute.\n\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_WRITE`" }, "response": [ { "id": "ac2b4a20-8c45-41ac-bb2b-2b7a757f2c98", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"evidence\": {\n \"category\": \"RELATED_TRANSACTION_DOCUMENTATION\",\n \"text\": \"\",\n \"metadata\": {\n \"in_81b\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence-text", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence-text" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"evidence\": {\n \"id\": \"\",\n \"dispute_id\": \"\",\n \"category\": \"PURCHASE_ACKNOWLEDGEMENT\",\n \"type\": \"TEXT\",\n \"created_at\": \"\",\n \"file\": {\n \"filename\": \"\",\n \"content_type\": \"image/tiff\"\n },\n \"text\": \"\",\n \"metadata\": {\n \"do_ed\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-ac2b4a20-8c45-41ac-bb2b-2b7a757f2c98" }, { "id": "295dcbc2-b829-401a-a776-2b4dc793f215", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"evidence\": {\n \"category\": \"RELATED_TRANSACTION_DOCUMENTATION\",\n \"text\": \"\",\n \"metadata\": {\n \"in_81b\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence-text", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence-text" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-295dcbc2-b829-401a-a776-2b4dc793f215" }, { "id": "0513ee6b-7423-4097-bdce-ced8e6656781", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"idempotency_key\": \"\",\n \"evidence\": {\n \"category\": \"RELATED_TRANSACTION_DOCUMENTATION\",\n \"text\": \"\",\n \"metadata\": {\n \"in_81b\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence-text", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence-text" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-0513ee6b-7423-4097-bdce-ced8e6656781" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b93d84ca-9d64-4789-bf60-a6c26de32e43" } ], "id": "7fead45e-7662-4335-8eb3-6228383e2b45", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-7fead45e-7662-4335-8eb3-6228383e2b45" }, { "name": "evidence-file", "item": [ { "name": "Create dispute evidence file", "id": "4809f2c1-23a2-4d76-8cf0-be1068612be2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) JSON-encoded payload describing the contents of the file uploaded", "key": "request", "value": "[object Object]", "type": "text" }, { "description": "(Required) Binary file to upload\n\nMin size: `1 byte`\nMax size: `5 megabytes`", "key": "file", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence-file", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence-file" ], "variable": [ { "id": "4fa02ac4-15ce-48b7-8208-3c83b22fb9d5", "key": "dispute_id", "value": "", "description": "(Required) " } ] }, "description": "Uploads a binary file as a piece of evidence for the given dispute, which can then be submitted with the [challenge dispute](Network-API.v1.yaml/paths/~1disputes~1{dispute_id}~1challenge) endpoint.\n\nThe file must be one of the supported formats, or else it may not be usable to challenge the dispute:\n\n- `JPEG`\n- `HEIC`\n- `HEIF`\n- `PNG`\n- `PDF`\n- `TIFF`\n\n \nUploading evidence does not challenge the dispute. Make sure to call the [challenge dispute](Network-API.v1.yaml/paths/~1disputes~1{dispute_id}~1challenge) endpoint before the `response_due_at` timestamp, or else the merchant will automatically \"lose\" the dispute.\n\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_WRITE`\n\n---\n\n### Example request payload (cURL)\n\nThe following example shows how to make a request to upload a dispute file. There are two \"parts\" of the request:\n\n- `request`, a JSON blob that contains details about the file to upload\n- `file`, which contains the binary data for the file to be uploaded.\n\nUsing `cURL` to make the request, the request would look like the example below. Please refer to documentation for your particular language / framework and `multipart/form-data` requests to see how you should implement it in your own codebase.\n\nPlease refer to [Signing Multipart Requests](https://developers.cash.app/docs/partner/technical-documentation/api-fundamentals/requests/signing-requests) to compute a signature for the request.\n\n```curl\ncurl --request POST 'https://sandbox.api.cash.app/network/v1/disputes/DSPT_ztqn5hd8wmrzjzavmf60pjbzf/evidence-file' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Client CLIENT_ID API_KEY_ID' \\\n--header 'Content-Type: multipart/form-data' \\\n--header 'X-Region: PDX' \\\n--form 'request={\n \"idempotency_key\": \"e445c3fb-2caa-46fd-b0d3-aa7c7b00ab41\",\n \"evidence\": {\n \"category\": \"AUTHORIZATION_DOCUMENTATION\",\n \"file\": {\n \"filename\": \"evidence.pdf\",\n \"content_type\": \"application/pdf\"\n }\n }\n}' \\\n--form 'signature=SIGNATURE' \\\n--form 'file=path-to-file.pdf' \n```" }, "response": [ { "id": "6f1c562e-9138-4afe-bf85-5a13ff18127a", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) JSON-encoded payload describing the contents of the file uploaded", "key": "request", "value": "[object Object]", "type": "text" }, { "description": "(Required) Binary file to upload\n\nMin size: `1 byte`\nMax size: `5 megabytes`", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence-file", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence-file" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"evidence\": {\n \"id\": \"\",\n \"dispute_id\": \"\",\n \"category\": \"RELATED_TRANSACTION_DOCUMENTATION\",\n \"type\": \"TEXT\",\n \"created_at\": \"\",\n \"file\": {\n \"filename\": \"\",\n \"content_type\": \"image/png\"\n },\n \"text\": \"\",\n \"metadata\": {\n \"tempora\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-6f1c562e-9138-4afe-bf85-5a13ff18127a" }, { "id": "a5d5b605-aea8-450e-a3c5-ba079b0fabe4", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) JSON-encoded payload describing the contents of the file uploaded", "key": "request", "value": "[object Object]", "type": "text" }, { "description": "(Required) Binary file to upload\n\nMin size: `1 byte`\nMax size: `5 megabytes`", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence-file", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence-file" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-a5d5b605-aea8-450e-a3c5-ba079b0fabe4" }, { "id": "9ac344d1-0ac6-4175-9286-16f953555750", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) JSON-encoded payload describing the contents of the file uploaded", "key": "request", "value": "[object Object]", "type": "text" }, { "description": "(Required) Binary file to upload\n\nMin size: `1 byte`\nMax size: `5 megabytes`", "key": "file", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/disputes/:dispute_id/evidence-file", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id", "evidence-file" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-9ac344d1-0ac6-4175-9286-16f953555750" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-4809f2c1-23a2-4d76-8cf0-be1068612be2" } ], "id": "c254948f-78d9-456d-a515-d3821a08756b", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-c254948f-78d9-456d-a515-d3821a08756b" }, { "name": "Retrieve dispute", "id": "f60bb29c-7946-42b9-a1fa-2a23b9d71f7a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id" ], "variable": [ { "id": "5b848620-9790-4513-a787-386b1c3374ad", "key": "dispute_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a dispute by its ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `DISPUTES_READ`" }, "response": [ { "id": "4228275e-b617-461a-ae50-85b663badc81", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"dispute\": {\n \"id\": \"\",\n \"payment_id\": \"\",\n \"amount\": \"\",\n \"reason\": \"PE11\",\n \"settlement_withholding\": \"WITHHELD_ALREADY\",\n \"state\": \"PARTIALLY_WON\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"merchant_id\": \"\",\n \"customer_credited_amount\": \"\",\n \"response_due_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-4228275e-b617-461a-ae50-85b663badc81" }, { "id": "7e626a41-c28e-491d-af7f-436b97ae1a1e", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes/:dispute_id", "host": [ "{{baseUrl}}" ], "path": [ "disputes", ":dispute_id" ], "variable": [ { "key": "dispute_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-7e626a41-c28e-491d-af7f-436b97ae1a1e" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-f60bb29c-7946-42b9-a1fa-2a23b9d71f7a" } ], "id": "98930adc-4433-4c9e-807c-9e58f51bd1d9", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-98930adc-4433-4c9e-807c-9e58f51bd1d9" }, { "name": "List disputes", "id": "a07f0a00-fd52-43c6-8115-c6968a20174a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes?cursor=&limit=50&merchant_id=", "host": [ "{{baseUrl}}" ], "path": [ "disputes" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of disputes to return.", "key": "limit", "value": "50" }, { "description": "Filters results to only include disputes filed against a merchant that matches the the given ID.", "key": "merchant_id", "value": "" } ] }, "description": "Returns a list of all disputes (matching the given query parameters) associated with payments created by this client.\n\n**This endpoint is rate limited to 50 QPS.**\n\nScopes: `DISPUTES_READ`" }, "response": [ { "id": "6a2bb231-bbd8-4203-8b26-d3c6175efe48", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes?cursor=&limit=50&merchant_id=", "host": [ "{{baseUrl}}" ], "path": [ "disputes" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of disputes to return.", "key": "limit", "value": "50" }, { "description": "Filters results to only include disputes filed against a merchant that matches the the given ID.", "key": "merchant_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"disputes\": [\n {\n \"id\": \"\",\n \"payment_id\": \"\",\n \"amount\": \"\",\n \"reason\": \"PE11\",\n \"settlement_withholding\": \"WITHHELD_ALREADY\",\n \"state\": \"ACCEPTED\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"merchant_id\": \"\",\n \"customer_credited_amount\": \"\",\n \"response_due_at\": \"\"\n },\n {\n \"id\": \"\",\n \"payment_id\": \"\",\n \"amount\": \"\",\n \"reason\": \"PE12\",\n \"settlement_withholding\": \"WITHHELD_ALREADY\",\n \"state\": \"LOST\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"merchant_id\": \"\",\n \"customer_credited_amount\": \"\",\n \"response_due_at\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-6a2bb231-bbd8-4203-8b26-d3c6175efe48" }, { "id": "be92e0b3-f6dc-43f7-bebc-8d9f5285d506", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disputes?cursor=&limit=50&merchant_id=", "host": [ "{{baseUrl}}" ], "path": [ "disputes" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of disputes to return.", "key": "limit", "value": "50" }, { "description": "Filters results to only include disputes filed against a merchant that matches the the given ID.", "key": "merchant_id", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-be92e0b3-f6dc-43f7-bebc-8d9f5285d506" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-a07f0a00-fd52-43c6-8115-c6968a20174a" } ], "id": "2f6343e3-ef4c-4d54-ba1f-aabe4ca8e239", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-2f6343e3-ef4c-4d54-ba1f-aabe4ca8e239" }, { "name": "fee-plans", "item": [ { "name": "{fee_plan_id}", "item": [ { "name": "Retrieve Fee Plan", "id": "ebe690b1-2e38-4a9e-b66b-bda527e95307", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/fee-plans/:fee_plan_id", "host": [ "{{baseUrl}}" ], "path": [ "fee-plans", ":fee_plan_id" ], "variable": [ { "id": "66c83037-6eeb-431b-aa54-dcf2ef772d19", "key": "fee_plan_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a fee plan by its ID.\n\n**This endpoint is not rate limited.**\n\nScopes: `FEE_PLANS_READ`" }, "response": [ { "id": "b1ed0b38-92b7-44a5-98df-48caf564232d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/fee-plans/:fee_plan_id", "host": [ "{{baseUrl}}" ], "path": [ "fee-plans", ":fee_plan_id" ], "variable": [ { "key": "fee_plan_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"fee_plan\": {\n \"id\": \"\",\n \"rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"currency\": \"USD\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"irure_3\": \"\"\n },\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b1ed0b38-92b7-44a5-98df-48caf564232d" }, { "id": "b2779203-90e2-449f-bbc8-413c56ea82d2", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/fee-plans/:fee_plan_id", "host": [ "{{baseUrl}}" ], "path": [ "fee-plans", ":fee_plan_id" ], "variable": [ { "key": "fee_plan_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-b2779203-90e2-449f-bbc8-413c56ea82d2" }, { "id": "63245733-cc99-4eed-9c2a-17b371e5ceee", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/fee-plans/:fee_plan_id", "host": [ "{{baseUrl}}" ], "path": [ "fee-plans", ":fee_plan_id" ], "variable": [ { "key": "fee_plan_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-63245733-cc99-4eed-9c2a-17b371e5ceee" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-ebe690b1-2e38-4a9e-b66b-bda527e95307" } ], "id": "97dda1d1-d6d7-43bd-a815-6bc9870ba852", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-97dda1d1-d6d7-43bd-a815-6bc9870ba852" }, { "name": "List fee plans", "id": "512dbb09-442b-4396-ab6e-ebe53f37156a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/fee-plans?cursor=&limit=50¤cy=USD&status=ACTIVE&reference_id=", "host": [ "{{baseUrl}}" ], "path": [ "fee-plans" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of fee plans to return.", "key": "limit", "value": "50" }, { "description": "Filters results to only include fee plans that matches the the given currency.", "key": "currency", "value": "USD" }, { "description": "Filters results to only include fee plans that matches the the given status.", "key": "status", "value": "ACTIVE" }, { "description": "Filters results to only include the fee plans that match the given reference ID.", "key": "reference_id", "value": "" } ] }, "description": "Returns a list of all fee plans (matching the given query parameters) associated with this client.\n\n**This endpoint is rate limited to 50 QPS.**\n\nScopes: `FEE_PLANS_READ`" }, "response": [ { "id": "12fbdda6-0b07-4dd1-aa97-32b29ba82bcd", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/fee-plans?cursor=&limit=50¤cy=USD&status=ACTIVE&reference_id=", "host": [ "{{baseUrl}}" ], "path": [ "fee-plans" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of fee plans to return.", "key": "limit", "value": "50" }, { "description": "Filters results to only include fee plans that matches the the given currency.", "key": "currency", "value": "USD" }, { "description": "Filters results to only include fee plans that matches the the given status.", "key": "status", "value": "ACTIVE" }, { "description": "Filters results to only include the fee plans that match the given reference ID.", "key": "reference_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"fee_plans\": [\n {\n \"id\": \"\",\n \"rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"currency\": \"USD\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"ex_f6\": \"\",\n \"et_99c\": \"\"\n },\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"rate\": {\n \"basis_points\": \"\",\n \"fixed_amount\": \"\"\n },\n \"currency\": \"USD\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"metadata\": {\n \"ut_52a\": \"\"\n },\n \"description\": \"\"\n }\n ],\n \"cursor\": \"\"\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-12fbdda6-0b07-4dd1-aa97-32b29ba82bcd" }, { "id": "1417f6ac-c1a9-48ec-a9b4-2574e78732a5", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) ", "key": "X-Region", "value": "" }, { "description": "(Required) ", "key": "X-Signature", "value": "" }, { "description": "(Required) ", "key": "User-Agent", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/fee-plans?cursor=&limit=50¤cy=USD&status=ACTIVE&reference_id=", "host": [ "{{baseUrl}}" ], "path": [ "fee-plans" ], "query": [ { "description": "A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query.", "key": "cursor", "value": "" }, { "description": "Maximum number of fee plans to return.", "key": "limit", "value": "50" }, { "description": "Filters results to only include fee plans that matches the the given currency.", "key": "currency", "value": "USD" }, { "description": "Filters results to only include fee plans that matches the the given status.", "key": "status", "value": "ACTIVE" }, { "description": "Filters results to only include the fee plans that match the given reference ID.", "key": "reference_id", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"category\": \"WEBHOOK_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n },\n {\n \"category\": \"RATE_LIMIT_ERROR\",\n \"code\": \"\",\n \"detail\": \"\",\n \"field\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-1417f6ac-c1a9-48ec-a9b4-2574e78732a5" } ], "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-512dbb09-442b-4396-ab6e-ebe53f37156a" } ], "id": "941c7889-ba7f-4619-baf6-071566efff6c", "createdAt": "2026-07-28T01:17:15.000Z", "updatedAt": "2026-07-28T01:17:15.000Z", "uid": "35240-941c7889-ba7f-4619-baf6-071566efff6c" } ], "variable": [ { "key": "baseUrl", "value": "https://api.cash.app/network/v1" } ] }