{ "info": { "_postman_id": "2af9cf0d-7832-44cd-8373-75d8c75af7d7", "name": "Assembly API", "description": "Assembly (formely PromisePay) is a powerful payments engine custom-built for platforms and marketplaces.\n\nContact Support:\n Email: support@assemblypayments.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "lastUpdatedBy": "35240", "uid": "35240-2af9cf0d-7832-44cd-8373-75d8c75af7d7" }, "item": [ { "name": "tokens", "item": [ { "name": "Token", "id": "dc9df342-e705-480b-b1ca-d3b9229eab94", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"10ajtntet1ccghuo8mv9ojglma\",\n \"client_secret\": \"hto00nsjk6osurndceon4rsn2irhi8s4lurau5f797d0smb94l6\",\n \"scope\": \"im-au-04/cdbf9590-1db6-0139-ac4d-0a58a9feac03\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tokens", "host": [ "{{baseUrl}}" ], "path": [ "tokens" ] }, "description": "Exchange client application credentials for a bearer token. Please ensure to call the auth issuing server as described at https://developer.assemblypayments.com/reference#authentication" }, "response": [ { "id": "9ac7bb44-ea75-4ea5-9078-4054bde7c3e7", "name": "Response body contains an access token with lifetime in seconds and usage information.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"10ajtntet1ccghuo8mv9ojglma\",\n \"client_secret\": \"hto00nsjk6osurndceon4rsn2irhi8s4lurau5f797d0smb94l6\",\n \"scope\": \"im-au-04/cdbf9590-1db6-0139-ac4d-0a58a9feac03\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tokens", "host": [ "{{baseUrl}}" ], "path": [ "tokens" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"\"\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9ac7bb44-ea75-4ea5-9078-4054bde7c3e7" }, { "id": "765fe778-1655-4c5e-85c4-8f7cbf412e68", "name": "Request not parseable, grant type invalid or properties missing", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"10ajtntet1ccghuo8mv9ojglma\",\n \"client_secret\": \"hto00nsjk6osurndceon4rsn2irhi8s4lurau5f797d0smb94l6\",\n \"scope\": \"im-au-04/cdbf9590-1db6-0139-ac4d-0a58a9feac03\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tokens", "host": [ "{{baseUrl}}" ], "path": [ "tokens" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-765fe778-1655-4c5e-85c4-8f7cbf412e68" }, { "id": "7ed0cbcb-fde5-42ec-a627-78dd553acaa7", "name": "We can't resolve the supplied credentials", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"10ajtntet1ccghuo8mv9ojglma\",\n \"client_secret\": \"hto00nsjk6osurndceon4rsn2irhi8s4lurau5f797d0smb94l6\",\n \"scope\": \"im-au-04/cdbf9590-1db6-0139-ac4d-0a58a9feac03\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tokens", "host": [ "{{baseUrl}}" ], "path": [ "tokens" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-7ed0cbcb-fde5-42ec-a627-78dd553acaa7" }, { "id": "69b7590f-8ff0-4e10-a698-d6012636e1a8", "name": "One or more property values are unprocessable", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"10ajtntet1ccghuo8mv9ojglma\",\n \"client_secret\": \"hto00nsjk6osurndceon4rsn2irhi8s4lurau5f797d0smb94l6\",\n \"scope\": \"im-au-04/cdbf9590-1db6-0139-ac4d-0a58a9feac03\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tokens", "host": [ "{{baseUrl}}" ], "path": [ "tokens" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-69b7590f-8ff0-4e10-a698-d6012636e1a8" }, { "id": "61d37eec-8752-4761-bc73-0e89efa38666", "name": "We have a problem, which we have logged. Please try again later and if it still doesn't work, contact us.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"10ajtntet1ccghuo8mv9ojglma\",\n \"client_secret\": \"hto00nsjk6osurndceon4rsn2irhi8s4lurau5f797d0smb94l6\",\n \"scope\": \"im-au-04/cdbf9590-1db6-0139-ac4d-0a58a9feac03\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tokens", "host": [ "{{baseUrl}}" ], "path": [ "tokens" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": \"\"\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-61d37eec-8752-4761-bc73-0e89efa38666" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-dc9df342-e705-480b-b1ca-d3b9229eab94" } ], "id": "ba85ff41-7340-4028-90bf-3fbcf6d28bb5", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ba85ff41-7340-4028-90bf-3fbcf6d28bb5" }, { "name": "addresses", "item": [ { "name": "{id}", "item": [ { "name": "Show Address", "id": "4c3be018-6044-43c1-a594-87e738e17a9e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/addresses/:id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":id" ], "variable": [ { "id": "9914c42e-eacc-48a0-a65d-4ba33e15bfe6", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) Address ID" } ] }, "description": "Show details of a specific Address using a given address `:id`." }, "response": [ { "id": "d99fadc4-a7a5-43e9-b1dc-97d0f4a121b6", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/addresses/:id", "host": [ "{{baseUrl}}" ], "path": [ "addresses", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"addresses\": {\n \"addressline1\": \"\",\n \"addressline2\": \"\",\n \"postcode\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"id\": \"\",\n \"country\": \"\",\n \"links\": {\n \"self\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d99fadc4-a7a5-43e9-b1dc-97d0f4a121b6" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4c3be018-6044-43c1-a594-87e738e17a9e" } ], "id": "ea9e4117-752d-403f-baad-f29d6fd281ca", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ea9e4117-752d-403f-baad-f29d6fd281ca" } ], "id": "ef957014-3e2e-4173-899d-b4b046155b4f", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ef957014-3e2e-4173-899d-b4b046155b4f" }, { "name": "bank_accounts", "item": [ { "name": "{id}", "item": [ { "name": "penny_send", "item": [ { "name": "Send Penny Amount", "id": "bcd8cdca-f885-4d4b-bfea-d380db5d0193", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:id/penny_send", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":id", "penny_send" ], "variable": [ { "id": "26f70b81-ab43-4c06-b0c1-f197ea2e42b2", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) Bank account ID" } ] }, "description": "When penny verification is enabled, this API call sends two penny transactions to the specified bank account for verification. **Note**: This API call is not required when your platform has automatic penny verification enabled, as this is instead done by the system. Penny credit verification is only supported for US platforms.\n" }, "response": [ { "id": "92a25a5d-d9cd-44af-9b73-fa7fe18fe0f9", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:id/penny_send", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":id", "penny_send" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bank_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"not_verified\",\n \"verification\": {\n \"verified_at\": \"\",\n \"verification_method\": \"COP\",\n \"result\": {\n \"match_result\": \"NMTO\"\n }\n },\n \"bank\": {\n \"bank_name\": \"\",\n \"country\": \"\",\n \"account_name\": \"\",\n \"routing_number\": \"\",\n \"account_number\": \"\",\n \"holder_type\": \"business\",\n \"account_type\": \"savings\",\n \"direct_debit_authority_status\": \"null\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"direct_debit_authorities\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-92a25a5d-d9cd-44af-9b73-fa7fe18fe0f9" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-bcd8cdca-f885-4d4b-bfea-d380db5d0193" } ], "id": "faa50e5a-5c8e-4cfc-82f8-920c026c70a0", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-faa50e5a-5c8e-4cfc-82f8-920c026c70a0" }, { "name": "penny_verify", "item": [ { "name": "Verify Penny Amount", "id": "e49c6cc0-a93d-4ed7-adc3-1b9a42828ac4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount_1\": 10,\n \"amount_2\": 20\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bank_accounts/:id/penny_verify", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":id", "penny_verify" ], "variable": [ { "id": "b3af317f-3ee2-4a95-99e2-d27b09da07d6", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) Bank account ID" } ] }, "description": "When penny verification is enabled, this API call verifies the two penny transactions that were sent to a specified bank account using **Send Penny Amount**. **Note**: This API call requires you to provide a front-end interface to your end-users into which they can input the penny amounts required for a successful verification. Your front-end interface should then pass the information into this API call. Penny credit verification is only supported for US platforms.\n" }, "response": [ { "id": "2898d52d-3c75-4e96-affe-c44e890185a6", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount_1\": 10,\n \"amount_2\": 20\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bank_accounts/:id/penny_verify", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":id", "penny_verify" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bank_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"not_verified\",\n \"verification\": {\n \"verified_at\": \"\",\n \"verification_method\": \"COP\",\n \"result\": {\n \"match_result\": \"NMTO\"\n }\n },\n \"bank\": {\n \"bank_name\": \"\",\n \"country\": \"\",\n \"account_name\": \"\",\n \"routing_number\": \"\",\n \"account_number\": \"\",\n \"holder_type\": \"business\",\n \"account_type\": \"savings\",\n \"direct_debit_authority_status\": \"null\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"direct_debit_authorities\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2898d52d-3c75-4e96-affe-c44e890185a6" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-e49c6cc0-a93d-4ed7-adc3-1b9a42828ac4" } ], "id": "a6336e06-ec09-43d3-8eae-6b632add999b", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a6336e06-ec09-43d3-8eae-6b632add999b" }, { "name": "users", "item": [ { "name": "Show Bank Account User", "id": "0ea5e51f-959d-432f-83dc-23897352f30e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":id", "users" ], "variable": [ { "id": "bad7df56-0937-46c9-b87d-189dcd90ca3e", "key": "id", "value": "901d8cd0-6af3-0138-967d-0a58a9feac04", "description": "(Required) Bank account ID" } ] }, "description": "Show the **User** the **Bank Account** is associated with using a given `:id`." }, "response": [ { "id": "4151e562-4d17-4cf3-a4f5-ca38e21101ca", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4151e562-4d17-4cf3-a4f5-ca38e21101ca" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-0ea5e51f-959d-432f-83dc-23897352f30e" } ], "id": "d2a88ec1-17dd-464f-bb41-951c3b55bb88", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d2a88ec1-17dd-464f-bb41-951c3b55bb88" }, { "name": "Show Bank Account", "id": "38c8ab7d-c15f-41f4-a739-40b97ae260a8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:id?include_decrypted_fields=false", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":id" ], "query": [ { "description": "If true, the API will decrypt and return sensitive bank account fields (for example, the full account number). Defaults to false", "key": "include_decrypted_fields", "value": "false" } ], "variable": [ { "id": "010934bd-8088-48f0-bf2f-1ea320a04351", "key": "id", "value": "", "description": "(Required) Bank account ID" } ] }, "description": "Show details of a specific **Bank Account** using a given `:id`." }, "response": [ { "id": "b3551cdb-6150-4f7b-96cf-114076879493", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:id?include_decrypted_fields=false", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":id" ], "query": [ { "description": "If true, the API will decrypt and return sensitive bank account fields (for example, the full account number). Defaults to false", "key": "include_decrypted_fields", "value": "false" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bank_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"not_verified\",\n \"verification\": {\n \"verified_at\": \"\",\n \"verification_method\": \"COP\",\n \"result\": {\n \"match_result\": \"NMTO\"\n }\n },\n \"bank\": {\n \"bank_name\": \"\",\n \"country\": \"\",\n \"account_name\": \"\",\n \"routing_number\": \"\",\n \"account_number\": \"\",\n \"holder_type\": \"business\",\n \"account_type\": \"savings\",\n \"direct_debit_authority_status\": \"null\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"direct_debit_authorities\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b3551cdb-6150-4f7b-96cf-114076879493" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-38c8ab7d-c15f-41f4-a739-40b97ae260a8" }, { "name": "Redact Bank Account", "id": "e2c9e985-b05b-45e1-9590-7c3bba1c4829", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":id" ], "variable": [ { "id": "16d753c8-dc43-41f9-82e8-0e74e0544c52", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) Bank account ID" } ] }, "description": "Redact a **Bank Account** using a given `:id`. Redacted **Bank Accounts** can no longer be used as a funding source or a Disbursement destination.\n" }, "response": [ { "id": "2e5293b0-722b-4c53-a485-b5894db601d4", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bank_account\": \"\"\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2e5293b0-722b-4c53-a485-b5894db601d4" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-e2c9e985-b05b-45e1-9590-7c3bba1c4829" } ], "id": "56158c62-7611-4825-b214-5457595bdbc8", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-56158c62-7611-4825-b214-5457595bdbc8" }, { "name": "Create Bank Account", "id": "dfec744e-c8b1-41c4-8b2a-bded8f49972d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"bank_name\": \"Bank of Australia\",\n \"account_name\": \"Samuel Seller\",\n \"routing_number\": \"111123\",\n \"account_number\": \"111234\",\n \"account_type\": \"checking\",\n \"holder_type\": \"personal\",\n \"country\": \"AUS\",\n \"payout_currency\": \"\",\n \"currency\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bank_accounts", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts" ] }, "description": "Create a **Bank Account** to be used as either a funding source or a Disbursement destination. Store the returned `:id` and use it for a `make_payment` **Item Action** call. The `:id` is also referred to as a `token` when involving **Bank Accounts**. \n" }, "response": [ { "id": "5a116857-b32c-4050-a244-fbd95f922c29", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\",\n \"bank_name\": \"Bank of Australia\",\n \"account_name\": \"Samuel Seller\",\n \"routing_number\": \"111123\",\n \"account_number\": \"111234\",\n \"account_type\": \"checking\",\n \"holder_type\": \"personal\",\n \"country\": \"AUS\",\n \"payout_currency\": \"\",\n \"currency\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bank_accounts", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bank_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"not_verified\",\n \"verification\": {\n \"verified_at\": \"\",\n \"verification_method\": \"COP\",\n \"result\": {\n \"match_result\": \"NMTO\"\n }\n },\n \"bank\": {\n \"bank_name\": \"\",\n \"country\": \"\",\n \"account_name\": \"\",\n \"routing_number\": \"\",\n \"account_number\": \"\",\n \"holder_type\": \"business\",\n \"account_type\": \"savings\",\n \"direct_debit_authority_status\": \"null\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"direct_debit_authorities\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-5a116857-b32c-4050-a244-fbd95f922c29" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-dfec744e-c8b1-41c4-8b2a-bded8f49972d" } ], "id": "185754b1-7464-45d6-a19a-7533ecf2415b", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-185754b1-7464-45d6-a19a-7533ecf2415b" }, { "name": "tools", "item": [ { "name": "routing_number", "item": [ { "name": "Validate Routing Number", "id": "979be793-efe2-4572-8b2f-fced4e0e5eb9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tools/routing_number?routing_number=122235821", "host": [ "{{baseUrl}}" ], "path": [ "tools", "routing_number" ], "query": [ { "description": "(Required) Bank account routing number", "key": "routing_number", "value": "122235821" } ] }, "description": "Validate a US bank routing number before creating an account. This can be used to provide on-demand verification, and further information of the bank information a User is providing." }, "response": [ { "id": "ac2a293a-8b15-4015-9527-40fa9d5ecabb", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/tools/routing_number?routing_number=122235821", "host": [ "{{baseUrl}}" ], "path": [ "tools", "routing_number" ], "query": [ { "description": "(Required) Bank account routing number", "key": "routing_number", "value": "122235821" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"routing_number\": {\n \"routing_number\": \"\",\n \"customer_name\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"state_code\": \"\",\n \"zip\": \"\",\n \"zip_extension\": \"\",\n \"phone_area_code\": \"\",\n \"phone_prefix\": \"\",\n \"phone_suffix\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ac2a293a-8b15-4015-9527-40fa9d5ecabb" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-979be793-efe2-4572-8b2f-fced4e0e5eb9" } ], "id": "4693772a-1956-4a63-a7c2-00f1ab7f1209", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4693772a-1956-4a63-a7c2-00f1ab7f1209" }, { "name": "status", "item": [ { "name": "Health check", "id": "d2841067-4b36-42c9-a587-5b18031dec21", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tools/status", "host": [ "{{baseUrl}}" ], "path": [ "tools", "status" ] }, "description": "Displays a health check of the Assembly service." }, "response": [ { "id": "374512f0-8eff-440f-a124-414758708e0c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/tools/status", "host": [ "{{baseUrl}}" ], "path": [ "tools", "status" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-374512f0-8eff-440f-a124-414758708e0c" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d2841067-4b36-42c9-a587-5b18031dec21" } ], "id": "827f1a97-b53e-4256-b258-47310149becd", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-827f1a97-b53e-4256-b258-47310149becd" } ], "id": "d495b29f-ff07-429a-a9bc-ee12ade944b9", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d495b29f-ff07-429a-a9bc-ee12ade944b9" }, { "name": "bpay_accounts", "item": [ { "name": "{id}", "item": [ { "name": "users", "item": [ { "name": "Show BPay Account User", "id": "330e82f3-09bb-41c3-93b2-c802b2e195ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bpay_accounts/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "bpay_accounts", ":id", "users" ], "variable": [ { "id": "55dd3ecf-5386-4e3d-93e3-76e301eaa04c", "key": "id", "value": "901d8cd0-6af3-0138-967d-0a58a9feac04", "description": "(Required) BPay account ID" } ] }, "description": "Show the **User** the **BPay Account** is associated with using a given `:id`." }, "response": [ { "id": "9f74ec86-40c7-4907-b435-6c71a64e0a37", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bpay_accounts/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "bpay_accounts", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9f74ec86-40c7-4907-b435-6c71a64e0a37" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-330e82f3-09bb-41c3-93b2-c802b2e195ac" } ], "id": "25e246ec-366d-4bdc-b099-d24eb19965f6", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-25e246ec-366d-4bdc-b099-d24eb19965f6" }, { "name": "Show BPay Account", "id": "5e72a217-12e7-4ce7-b2a6-94b160f28908", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bpay_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "bpay_accounts", ":id" ], "variable": [ { "id": "a7ad15d6-c170-40e0-bfa7-bfcf5d62092a", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) BPay account ID" } ] }, "description": "Show details of a specific **BPay Account** using a given `:id`." }, "response": [ { "id": "561702f4-a689-4d56-826f-ea14eeac9593", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bpay_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "bpay_accounts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bpay_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"verified\",\n \"bpay_details\": {\n \"account_name\": \"\",\n \"biller_code\": \"\",\n \"biller_name\": \"\",\n \"crn\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-561702f4-a689-4d56-826f-ea14eeac9593" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-5e72a217-12e7-4ce7-b2a6-94b160f28908" } ], "id": "f66604fa-2881-4241-84c9-fed497fb4462", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-f66604fa-2881-4241-84c9-fed497fb4462" }, { "name": "Create BPay Account", "id": "20680db6-b9b9-4b1c-a197-6c212210bbbe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"725cc8c0-759b-0138-5d6d-0a58a9feac05\",\n \"account_name\": \"My Water Bill Company\",\n \"biller_code\": \"123456\",\n \"bpay_crn\": \"987654321\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bpay_accounts", "host": [ "{{baseUrl}}" ], "path": [ "bpay_accounts" ] }, "description": "Create a **BPay Account** to be used as a Disbursement destination.\n" }, "response": [ { "id": "398803f7-f348-439b-b9eb-bb9ad4736262", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": \"725cc8c0-759b-0138-5d6d-0a58a9feac05\",\n \"account_name\": \"My Water Bill Company\",\n \"biller_code\": \"123456\",\n \"bpay_crn\": \"987654321\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/bpay_accounts", "host": [ "{{baseUrl}}" ], "path": [ "bpay_accounts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bpay_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"verified\",\n \"bpay_details\": {\n \"account_name\": \"\",\n \"biller_code\": \"\",\n \"biller_name\": \"\",\n \"crn\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-398803f7-f348-439b-b9eb-bb9ad4736262" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-20680db6-b9b9-4b1c-a197-6c212210bbbe" } ], "id": "04328df3-b8a3-40e9-8691-4cce95e0a241", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-04328df3-b8a3-40e9-8691-4cce95e0a241" }, { "name": "wallet_accounts", "item": [ { "name": "{id}", "item": [ { "name": "bill_payment", "item": [ { "name": "Pay a Bill", "id": "155bc221-876d-4102-9583-7b6062117dbb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"c1824ad0-73f1-0138-3700-0a58a9feac09\",\n \"amount\": \"\",\n \"reference_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/wallet_accounts/:id/bill_payment", "host": [ "{{baseUrl}}" ], "path": [ "wallet_accounts", ":id", "bill_payment" ], "variable": [ { "id": "40bc9a6c-9473-45dc-83af-7a35c34b6070", "key": "id", "value": "901d8cd0-6af3-0138-967d-0a58a9feac04", "description": "(Required) Account ID" } ] }, "description": "Pay a bill by withdrawing funds from a **Wallet Account** to a specified bpay account." }, "response": [ { "id": "c5655bd2-2f9c-45b9-93e4-28c08d9ebfe9", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"c1824ad0-73f1-0138-3700-0a58a9feac09\",\n \"amount\": \"\",\n \"reference_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/wallet_accounts/:id/bill_payment", "host": [ "{{baseUrl}}" ], "path": [ "wallet_accounts", ":id", "bill_payment" ], "variable": [ { "key": "id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"disbursements\": {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"batch_id\": \"\",\n \"cuscal_payment_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"\",\n \"to\": \"\",\n \"bank_name\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"npp_payout_state\": \"\",\n \"account_name\": \"\",\n \"biller_name\": \"\",\n \"biller_code\": \"\",\n \"crn\": \"\",\n \"links\": {\n \"transactions\": \"\",\n \"wallet_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"items\": \"\",\n \"users\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-c5655bd2-2f9c-45b9-93e4-28c08d9ebfe9" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-155bc221-876d-4102-9583-7b6062117dbb" } ], "id": "3f8ff760-e770-408e-bfcc-2813b969aadc", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-3f8ff760-e770-408e-bfcc-2813b969aadc" }, { "name": "users", "item": [ { "name": "Show Wallet Account User", "id": "7bfa0328-2514-4006-ad79-92de93dc9192", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/wallet_accounts/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "wallet_accounts", ":id", "users" ], "variable": [ { "id": "4194a22c-f30b-4410-abe5-e08520290b92", "key": "id", "value": "901d8cd0-6af3-0138-967d-0a58a9feac04", "description": "(Required) Account ID" } ] }, "description": "Show the **User** the **Wallet Account** is associated with using a given `:id`." }, "response": [ { "id": "11f223b8-0bef-41e9-967a-ff3bb914dd8e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/wallet_accounts/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "wallet_accounts", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-11f223b8-0bef-41e9-967a-ff3bb914dd8e" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-7bfa0328-2514-4006-ad79-92de93dc9192" } ], "id": "5e9e4db6-e782-4b63-b991-f289e4a3111e", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-5e9e4db6-e782-4b63-b991-f289e4a3111e" }, { "name": "withdraw", "item": [ { "name": "Withdraw Funds", "id": "c188ac60-f560-4e7e-8c19-793048288ba1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"c1824ad0-73f1-0138-3700-0a58a9feac09\",\n \"amount\": \"173\",\n \"custom_descriptor\": \"\",\n \"reference_id\": \"7190770-1-2908\",\n \"end_to_end_id\": \"NOTPROVIDED\",\n \"ifti_information\": {\n \"instruction_identification\": \"\",\n \"ultimate_debtor_information\": {\n \"name\": \"\",\n \"address\": {\n \"address_type\": \"PBOX\",\n \"department\": \"\",\n \"sub_department\": \"\",\n \"street_name\": \"\",\n \"bldg_name\": \"\",\n \"postcode\": \"\",\n \"town_name\": \"\",\n \"ctry_sub_division\": \"\",\n \"country_code\": \"CH\",\n \"address_line\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n },\n \"organisation_identification\": [\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n },\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n }\n ],\n \"organisation_bic\": \"ATUXFO8Y\",\n \"private_identification\": [\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n },\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n }\n ],\n \"date_place_of_birth\": {\n \"birth_date\": \"\",\n \"city_of_birth\": \"\",\n \"country_of_birth\": \"GI\",\n \"place_of_birth\": \"\"\n },\n \"country_of_residence\": \"RX\",\n \"contact_details\": {\n \"name_prefix\": \"DOCT\",\n \"name\": \"\",\n \"phone_number\": \"+1-05383-8))6\",\n \"mobile_number\": \"+62-(8-688\",\n \"fax_number\": \"+9-33(351211(-48146)-259\",\n \"email_address\": \"\",\n \"other\": \"\"\n }\n },\n \"charge_bearer\": \"DEBT\",\n \"previous_instructing_agent\": {\n \"agent_bic\": \"\",\n \"clearing_system_identification\": \"\",\n \"clearing_system_member_identification\": \"\"\n },\n \"creditor_agent_instruction\": {\n \"instruction_information\": \"\",\n \"code\": \"\"\n },\n \"initiating_party_information\": {\n \"name\": \"\",\n \"address\": {\n \"address_type\": \"ADDR\",\n \"department\": \"\",\n \"sub_department\": \"\",\n \"street_name\": \"\",\n \"bldg_name\": \"\",\n \"postcode\": \"\",\n \"town_name\": \"\",\n \"ctry_sub_division\": \"\",\n \"country_code\": \"NN\",\n \"address_line\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n },\n \"organisation_identification\": [\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n },\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n }\n ],\n \"organisation_bic\": \"HDAATXLAQKJ\",\n \"private_identification\": [\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n },\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n }\n ],\n \"date_place_of_birth\": {\n \"birth_date\": \"\",\n \"city_of_birth\": \"\",\n \"country_of_birth\": \"KV\",\n \"place_of_birth\": \"\"\n },\n \"country_of_residence\": \"VL\",\n \"contact_details\": {\n \"name_prefix\": \"MIST\",\n \"name\": \"\",\n \"phone_number\": \"+2-9(+331\",\n \"mobile_number\": \"+3-1)\",\n \"fax_number\": \"+301-1(+607711)821790(6))94+1--3(86\",\n \"email_address\": \"\",\n \"other\": \"\"\n }\n },\n \"ultimate_creditor_information\": {\n \"name\": \"\",\n \"address\": {\n \"address_type\": \"MLTO\",\n \"department\": \"\",\n \"sub_department\": \"\",\n \"street_name\": \"\",\n \"bldg_name\": \"\",\n \"postcode\": \"\",\n \"town_name\": \"\",\n \"ctry_sub_division\": \"\",\n \"country_code\": \"KC\",\n \"address_line\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n },\n \"organisation_identification\": [\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n },\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n }\n ],\n \"organisation_bic\": \"GKPKWN6NJLC\",\n \"private_identification\": [\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n },\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n }\n ],\n \"date_place_of_birth\": {\n \"birth_date\": \"\",\n \"city_of_birth\": \"\",\n \"country_of_birth\": \"JA\",\n \"place_of_birth\": \"\"\n },\n \"country_of_residence\": \"ZU\",\n \"contact_details\": {\n \"name_prefix\": \"MISS\",\n \"name\": \"\",\n \"phone_number\": \"+0-(50\",\n \"mobile_number\": \"+1-((0237(+58684792\",\n \"fax_number\": \"+74-4+36464\",\n \"email_address\": \"\",\n \"other\": \"\"\n }\n },\n \"instructed_amount\": {\n \"currency\": \"\",\n \"amount\": \"\"\n },\n \"exchange_rate\": \"\",\n \"payment_purpose_proprietary\": \"\",\n \"payment_information\": {\n \"remittance_information_unstructured\": \"\",\n \"payment_purpose_code\": \"\"\n },\n \"regulatory_reporting\": [\n {\n \"authority_name\": \"\"\n },\n {\n \"authority_name\": \"\"\n }\n ],\n \"remittance_information_structured\": {\n \"referred_document_amount\": {\n \"due_payable_amount\": {\n \"currency\": \"\",\n \"amount\": \"\"\n }\n }\n },\n \"related_remittance_information\": [\n {\n \"identification\": \"\"\n },\n {\n \"identification\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/wallet_accounts/:id/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "wallet_accounts", ":id", "withdraw" ], "variable": [ { "id": "575d9e71-2b5f-4106-aa66-96e6e2634762", "key": "id", "value": "bd6e9c20-73f1-0138-fb91-0a58a9feac09", "description": "(Required) Wallet account ID" } ] }, "description": "Withdraw funds from a **Wallet Account** to a specified disbursement account." }, "response": [ { "id": "4fccf9ba-25a3-44d9-bcee-a912f630cd37", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"c1824ad0-73f1-0138-3700-0a58a9feac09\",\n \"amount\": \"173\",\n \"custom_descriptor\": \"\",\n \"reference_id\": \"7190770-1-2908\",\n \"end_to_end_id\": \"NOTPROVIDED\",\n \"ifti_information\": {\n \"instruction_identification\": \"\",\n \"ultimate_debtor_information\": {\n \"name\": \"\",\n \"address\": {\n \"address_type\": \"PBOX\",\n \"department\": \"\",\n \"sub_department\": \"\",\n \"street_name\": \"\",\n \"bldg_name\": \"\",\n \"postcode\": \"\",\n \"town_name\": \"\",\n \"ctry_sub_division\": \"\",\n \"country_code\": \"CH\",\n \"address_line\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n },\n \"organisation_identification\": [\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n },\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n }\n ],\n \"organisation_bic\": \"ATUXFO8Y\",\n \"private_identification\": [\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n },\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n }\n ],\n \"date_place_of_birth\": {\n \"birth_date\": \"\",\n \"city_of_birth\": \"\",\n \"country_of_birth\": \"GI\",\n \"place_of_birth\": \"\"\n },\n \"country_of_residence\": \"RX\",\n \"contact_details\": {\n \"name_prefix\": \"DOCT\",\n \"name\": \"\",\n \"phone_number\": \"+1-05383-8))6\",\n \"mobile_number\": \"+62-(8-688\",\n \"fax_number\": \"+9-33(351211(-48146)-259\",\n \"email_address\": \"\",\n \"other\": \"\"\n }\n },\n \"charge_bearer\": \"DEBT\",\n \"previous_instructing_agent\": {\n \"agent_bic\": \"\",\n \"clearing_system_identification\": \"\",\n \"clearing_system_member_identification\": \"\"\n },\n \"creditor_agent_instruction\": {\n \"instruction_information\": \"\",\n \"code\": \"\"\n },\n \"initiating_party_information\": {\n \"name\": \"\",\n \"address\": {\n \"address_type\": \"ADDR\",\n \"department\": \"\",\n \"sub_department\": \"\",\n \"street_name\": \"\",\n \"bldg_name\": \"\",\n \"postcode\": \"\",\n \"town_name\": \"\",\n \"ctry_sub_division\": \"\",\n \"country_code\": \"NN\",\n \"address_line\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n },\n \"organisation_identification\": [\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n },\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n }\n ],\n \"organisation_bic\": \"HDAATXLAQKJ\",\n \"private_identification\": [\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n },\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n }\n ],\n \"date_place_of_birth\": {\n \"birth_date\": \"\",\n \"city_of_birth\": \"\",\n \"country_of_birth\": \"KV\",\n \"place_of_birth\": \"\"\n },\n \"country_of_residence\": \"VL\",\n \"contact_details\": {\n \"name_prefix\": \"MIST\",\n \"name\": \"\",\n \"phone_number\": \"+2-9(+331\",\n \"mobile_number\": \"+3-1)\",\n \"fax_number\": \"+301-1(+607711)821790(6))94+1--3(86\",\n \"email_address\": \"\",\n \"other\": \"\"\n }\n },\n \"ultimate_creditor_information\": {\n \"name\": \"\",\n \"address\": {\n \"address_type\": \"MLTO\",\n \"department\": \"\",\n \"sub_department\": \"\",\n \"street_name\": \"\",\n \"bldg_name\": \"\",\n \"postcode\": \"\",\n \"town_name\": \"\",\n \"ctry_sub_division\": \"\",\n \"country_code\": \"KC\",\n \"address_line\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n },\n \"organisation_identification\": [\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n },\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n }\n ],\n \"organisation_bic\": \"GKPKWN6NJLC\",\n \"private_identification\": [\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n },\n {\n \"identification\": \"\",\n \"identification_type_proprietary\": \"\",\n \"identification_type_code\": \"\",\n \"identification_issuer\": \"\"\n }\n ],\n \"date_place_of_birth\": {\n \"birth_date\": \"\",\n \"city_of_birth\": \"\",\n \"country_of_birth\": \"JA\",\n \"place_of_birth\": \"\"\n },\n \"country_of_residence\": \"ZU\",\n \"contact_details\": {\n \"name_prefix\": \"MISS\",\n \"name\": \"\",\n \"phone_number\": \"+0-(50\",\n \"mobile_number\": \"+1-((0237(+58684792\",\n \"fax_number\": \"+74-4+36464\",\n \"email_address\": \"\",\n \"other\": \"\"\n }\n },\n \"instructed_amount\": {\n \"currency\": \"\",\n \"amount\": \"\"\n },\n \"exchange_rate\": \"\",\n \"payment_purpose_proprietary\": \"\",\n \"payment_information\": {\n \"remittance_information_unstructured\": \"\",\n \"payment_purpose_code\": \"\"\n },\n \"regulatory_reporting\": [\n {\n \"authority_name\": \"\"\n },\n {\n \"authority_name\": \"\"\n }\n ],\n \"remittance_information_structured\": {\n \"referred_document_amount\": {\n \"due_payable_amount\": {\n \"currency\": \"\",\n \"amount\": \"\"\n }\n }\n },\n \"related_remittance_information\": [\n {\n \"identification\": \"\"\n },\n {\n \"identification\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/wallet_accounts/:id/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "wallet_accounts", ":id", "withdraw" ], "variable": [ { "key": "id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"reference_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"batch_id\": \"\",\n \"cuscal_payment_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"\",\n \"to\": \"\",\n \"bank_name\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"npp_payout_state\": \"\",\n \"account_name\": \"\",\n \"biller_name\": \"\",\n \"biller_code\": \"\",\n \"crn\": \"\",\n \"links\": {\n \"transactions\": \"\",\n \"wallet_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"items\": \"\",\n \"users\": \"\"\n },\n \"end_to_end_id\": \"\",\n \"ifti_information\": {\n \"instruction_identification\": \"\",\n \"ultimate_debtor_information\": {\n \"name\": \"\",\n \"country_of_residence\": \"\",\n \"address\": {\n \"country_code\": \"\",\n \"address_line\": \"\"\n },\n \"organisation_identification\": [\n {\n \"identification\": \"\"\n },\n {\n \"identification\": \"\"\n }\n ]\n },\n \"charge_bearer\": \"\",\n \"previous_instructing_agent\": {\n \"agent_bic\": \"\"\n },\n \"creditor_agent_instruction\": {\n \"instruction_information\": \"\",\n \"code\": \"\"\n },\n \"initiating_party_information\": {\n \"name\": \"\",\n \"country_of_residence\": \"\",\n \"address\": {\n \"country_code\": \"\",\n \"address_line\": \"\"\n },\n \"organisation_identification\": [\n {\n \"identification\": \"\"\n },\n {\n \"identification\": \"\"\n }\n ]\n },\n \"instructed_amount\": {\n \"currency\": \"\",\n \"amount\": \"\"\n },\n \"ultimate_creditor_information\": {\n \"name\": \"\",\n \"country_of_residence\": \"\",\n \"address\": {\n \"country_code\": \"\",\n \"address_line\": \"\"\n },\n \"organisation_identification\": [\n {\n \"identification\": \"\"\n },\n {\n \"identification\": \"\"\n }\n ]\n },\n \"exchange_rate\": \"\",\n \"payment_purpose_proprietary\": \"\",\n \"payment_information\": {\n \"remittance_information_unstructured\": \"\",\n \"payment_purpose_code\": \"\"\n },\n \"regulatory_reporting\": [\n {\n \"authority_name\": \"\"\n },\n {\n \"authority_name\": \"\"\n }\n ],\n \"remittance_information_structured\": {\n \"referred_document_amount\": {\n \"due_payable_amount\": {\n \"currency\": \"\",\n \"amount\": \"\"\n }\n }\n },\n \"related_remittance_information\": [\n {\n \"identification\": \"\"\n },\n {\n \"identification\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4fccf9ba-25a3-44d9-bcee-a912f630cd37" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-c188ac60-f560-4e7e-8c19-793048288ba1" } ], "id": "f21a1c69-1b08-4c6d-8809-7685693e962c", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-f21a1c69-1b08-4c6d-8809-7685693e962c" }, { "name": "npp_details", "item": [ { "name": "Show Wallet Account NPP Details", "id": "2af20f5a-f5a3-41ad-9ada-3c8243e60fb0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/wallet_accounts/:id/npp_details", "host": [ "{{baseUrl}}" ], "path": [ "wallet_accounts", ":id", "npp_details" ], "variable": [ { "id": "f53c5966-57d2-4afc-b27c-ae5aef656c0a", "key": "id", "value": "5c1c6b10-4c56-0137-8cd7-0242ac110002", "description": "(Required) Account ID" } ] }, "description": "Show NPP details of a specific **Wallet Account** using a given `:id.`" }, "response": [ { "id": "d15d0cfb-eea0-4ad8-bf17-d08e6d41ed38", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/wallet_accounts/:id/npp_details", "host": [ "{{baseUrl}}" ], "path": [ "wallet_accounts", ":id", "npp_details" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"npp_details\": {\n \"pay_id\": \"\",\n \"marketplace_pay_ids\": [\n {\n \"pay_id\": \"\",\n \"type\": \"emal\"\n },\n {\n \"pay_id\": \"\",\n \"type\": \"emal\"\n }\n ],\n \"reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d15d0cfb-eea0-4ad8-bf17-d08e6d41ed38" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2af20f5a-f5a3-41ad-9ada-3c8243e60fb0" } ], "id": "1f89acc5-966b-46eb-b5d8-6b03107117d8", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-1f89acc5-966b-46eb-b5d8-6b03107117d8" }, { "name": "bpay_details", "item": [ { "name": "Show Wallet Account BPAY Details", "id": "006d74dd-29f2-4c4f-b866-0c8cc56aece1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/wallet_accounts/:id/bpay_details", "host": [ "{{baseUrl}}" ], "path": [ "wallet_accounts", ":id", "bpay_details" ], "variable": [ { "id": "1de09f9a-6aee-417d-b0b3-be7b398b5326", "key": "id", "value": "5c1c6b10-4c56-0137-8cd7-0242ac110002", "description": "(Required) Account ID" } ] }, "description": "Show BPAY details of a specific **Wallet Account** using a given `:id.`" }, "response": [ { "id": "d6bbef1f-42f4-413d-88db-c0b5c45b33ca", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/wallet_accounts/:id/bpay_details", "host": [ "{{baseUrl}}" ], "path": [ "wallet_accounts", ":id", "bpay_details" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"bpay_details\": {\n \"biller_code\": \"\",\n \"reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d6bbef1f-42f4-413d-88db-c0b5c45b33ca" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-006d74dd-29f2-4c4f-b866-0c8cc56aece1" } ], "id": "5a3fe9d3-a275-4839-82de-7e515415194b", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-5a3fe9d3-a275-4839-82de-7e515415194b" }, { "name": "Show Wallet Account", "id": "f2bc972d-8ab7-4283-b76d-5b5b9c411135", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/wallet_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "wallet_accounts", ":id" ], "variable": [ { "id": "9a7c13f9-bb29-40be-9049-2a1c05272c36", "key": "id", "value": "5c1c6b10-4c56-0137-8cd7-0242ac110002", "description": "(Required) Account ID" } ] }, "description": "Show details of a specific **Wallet Account** using a given `:id.`" }, "response": [ { "id": "3baf11f1-1afb-4710-8715-2853cd698a86", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/wallet_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "wallet_accounts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"wallet_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"not_verified\",\n \"balance\": \"\",\n \"links\": {\n \"self\": {},\n \"users\": {},\n \"batch_transactions\": {},\n \"transactions\": {},\n \"bpay_details\": {},\n \"npp_details\": {},\n \"virtual_accounts\": {}\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-3baf11f1-1afb-4710-8715-2853cd698a86" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-f2bc972d-8ab7-4283-b76d-5b5b9c411135" } ], "id": "500eee97-8a3f-419e-a257-437eb1ee76c8", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-500eee97-8a3f-419e-a257-437eb1ee76c8" } ], "id": "1e4129d1-324c-4c74-92e1-90d679d23aeb", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-1e4129d1-324c-4c74-92e1-90d679d23aeb" }, { "name": "sub_wallets", "item": [ { "name": "{account_id}", "item": [ { "name": "List Sub-wallets", "id": "a3e629a4-cc5c-4145-9e22-8de515d7e9dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:account_id?offset=0&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":account_id" ], "query": [ { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" } ], "variable": [ { "id": "39a29665-529c-4ab9-a8c2-2f14f2c5cf00", "key": "account_id", "value": "901d8cd0-6af3-0138-967d-0a58a9feac04", "description": "(Required) Wallet Account Id" } ] }, "description": "List all the sub-wallets that belong to a user's wallet account. These are specified by the wallet `account_id`." }, "response": [ { "id": "4533e69a-49cf-4708-abe3-ab702af665f1", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:account_id?offset=0&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":account_id" ], "query": [ { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" } ], "variable": [ { "key": "account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sub_wallets\": [\n {\n \"sub_wallets\": {\n \"id\": \"\",\n \"name\": \"\",\n \"balance\": \"\",\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"currency\": \"\",\n \"links\": {\n \"self\": {},\n \"users\": {},\n \"transactions\": {},\n \"wallet_accounts\": {}\n }\n }\n },\n {\n \"sub_wallets\": {\n \"id\": \"\",\n \"name\": \"\",\n \"balance\": \"\",\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"currency\": \"\",\n \"links\": {\n \"self\": {},\n \"users\": {},\n \"transactions\": {},\n \"wallet_accounts\": {}\n }\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4533e69a-49cf-4708-abe3-ab702af665f1" }, { "id": "65054c39-0e34-42b4-a5fb-4001e0a3cfbe", "name": "unprocessable content", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:account_id?offset=0&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":account_id" ], "query": [ { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" } ], "variable": [ { "key": "account_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"field\": {}\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-65054c39-0e34-42b4-a5fb-4001e0a3cfbe" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a3e629a4-cc5c-4145-9e22-8de515d7e9dc" } ], "id": "cbac4092-2ea5-4ac4-a663-d90fe7fd4f48", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-cbac4092-2ea5-4ac4-a663-d90fe7fd4f48" }, { "name": "{id}", "item": [ { "name": "transactions", "item": [ { "name": "List Sub-wallet transactions", "id": "f0ab85d3-8286-423d-a4f2-3c4bcd1a10ff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id/transactions", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "transactions" ], "variable": [ { "id": "3cc13dfc-87cd-47fa-837d-df5d169d7f85", "key": "id", "value": "c66a1bec-4ca5-418c-8b0a-5513819576ee", "description": "(Required) sub-wallet ID" } ] }, "description": "List all transactions of a sub-wallet using the given `:id`." }, "response": [ { "id": "94f269b5-179e-4191-98a7-5e78c3a66c25", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id/transactions", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "transactions" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"sub_wallets_id\": \"\",\n \"sub_wallet_name\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"debit_credit\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\"\n },\n \"related\": {\n \"transactions\": [\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\"\n }\n ]\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"sub_wallets_id\": \"\",\n \"sub_wallet_name\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"debit_credit\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\"\n },\n \"related\": {\n \"transactions\": [\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\"\n }\n ]\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"meta\": {\n \"limit\": 10,\n \"offset\": 0,\n \"total\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-94f269b5-179e-4191-98a7-5e78c3a66c25" }, { "id": "9cdac199-3517-41dc-bd2c-5d55ab268a30", "name": "unprocessable content", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id/transactions", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "transactions" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"field\": {}\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9cdac199-3517-41dc-bd2c-5d55ab268a30" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-f0ab85d3-8286-423d-a4f2-3c4bcd1a10ff" } ], "id": "2ff3e845-c9a0-46ae-acc5-ff9899e77c19", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2ff3e845-c9a0-46ae-acc5-ff9899e77c19" }, { "name": "bill_payment", "item": [ { "name": "Pay a Bill", "id": "cb55df73-0dff-4ee4-9bfa-fcea2b72b087", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"c1824ad0-73f1-0138-3700-0a58a9feac09\",\n \"amount\": \"\",\n \"reference_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets/:id/bill_payment", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "bill_payment" ], "variable": [ { "id": "09c105b8-fb7f-4b03-80d9-8db536fb6b14", "key": "id", "value": "901d8cd0-6af3-0138-967d-0a58a9feac04", "description": "(Required) sub-wallet ID" } ] }, "description": "Pay a bill to a specified BPAY account that's associated with its `account_id` by withdrawing funds from a sub-wallet using the given `id`." }, "response": [ { "id": "a1211814-1b62-4375-bc04-5b14405fe18a", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"c1824ad0-73f1-0138-3700-0a58a9feac09\",\n \"amount\": \"\",\n \"reference_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets/:id/bill_payment", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "bill_payment" ], "variable": [ { "key": "id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"disbursements\": {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"batch_id\": \"\",\n \"cuscal_payment_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"\",\n \"to\": \"\",\n \"bank_name\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"npp_payout_state\": \"\",\n \"account_name\": \"\",\n \"biller_name\": \"\",\n \"biller_code\": \"\",\n \"crn\": \"\",\n \"links\": {\n \"transactions\": \"\",\n \"wallet_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"items\": \"\",\n \"users\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a1211814-1b62-4375-bc04-5b14405fe18a" }, { "id": "1deb295b-4df4-4691-93e6-98988ace0ddf", "name": "unprocessable content", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"c1824ad0-73f1-0138-3700-0a58a9feac09\",\n \"amount\": \"\",\n \"reference_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets/:id/bill_payment", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "bill_payment" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"field\": {}\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-1deb295b-4df4-4691-93e6-98988ace0ddf" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-cb55df73-0dff-4ee4-9bfa-fcea2b72b087" } ], "id": "f702adeb-e213-4d32-9f28-ba6b48fa7eff", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-f702adeb-e213-4d32-9f28-ba6b48fa7eff" }, { "name": "withdraw", "item": [ { "name": "Withdraw Funds", "id": "9f137021-8f8e-4a8b-a1ec-fca45b087205", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"c1824ad0-73f1-0138-3700-0a58a9feac09\",\n \"amount\": \"173\",\n \"custom_descriptor\": \"\",\n \"reference_id\": \"7190770-1-2908\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets/:id/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "withdraw" ], "variable": [ { "id": "36b60ab1-0a9b-4388-9faa-cebc6a663d46", "key": "id", "value": "bd6e9c20-73f1-0138-fb91-0a58a9feac09", "description": "(Required) sub-wallet ID" } ] }, "description": "Withdraw funds from a sub-wallet using the given `id` and move the specified amount to a disbursement account associated with the `account_id`." }, "response": [ { "id": "25078e4a-2283-4b88-9475-40eb10d976a6", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"c1824ad0-73f1-0138-3700-0a58a9feac09\",\n \"amount\": \"173\",\n \"custom_descriptor\": \"\",\n \"reference_id\": \"7190770-1-2908\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets/:id/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "withdraw" ], "variable": [ { "key": "id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"disbursements\": {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"batch_id\": \"\",\n \"cuscal_payment_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"\",\n \"to\": \"\",\n \"bank_name\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"npp_payout_state\": \"\",\n \"account_name\": \"\",\n \"biller_name\": \"\",\n \"biller_code\": \"\",\n \"crn\": \"\",\n \"links\": {\n \"transactions\": \"\",\n \"wallet_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"items\": \"\",\n \"users\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-25078e4a-2283-4b88-9475-40eb10d976a6" }, { "id": "4e30b85b-ef13-4666-b7e4-9139968ded91", "name": "unprocessable content", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"c1824ad0-73f1-0138-3700-0a58a9feac09\",\n \"amount\": \"173\",\n \"custom_descriptor\": \"\",\n \"reference_id\": \"7190770-1-2908\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets/:id/withdraw", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "withdraw" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"field\": {}\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4e30b85b-ef13-4666-b7e4-9139968ded91" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9f137021-8f8e-4a8b-a1ec-fca45b087205" } ], "id": "22eebc12-af48-434c-bdf0-3ee95c6efc9e", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-22eebc12-af48-434c-bdf0-3ee95c6efc9e" }, { "name": "users", "item": [ { "name": "Show Sub-wallet User", "id": "130152e1-0043-4a94-b05f-c6dc8071fcc3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "users" ], "variable": [ { "id": "8affa8d8-03bd-4aac-ae1b-27b79f7e7fc7", "key": "id", "value": "c66a1bec-4ca5-418c-8b0a-5513819576ee", "description": "(Required) sub-wallet ID" } ] }, "description": "Show the user that a sub-wallet is associated with using the given `:id`." }, "response": [ { "id": "3c39047b-895b-4914-ad6c-6a7f28c05598", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-3c39047b-895b-4914-ad6c-6a7f28c05598" }, { "id": "e1b0c2f0-dd1f-47a7-ab83-678144bdb526", "name": "unprocessable content", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"field\": {}\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-e1b0c2f0-dd1f-47a7-ab83-678144bdb526" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-130152e1-0043-4a94-b05f-c6dc8071fcc3" } ], "id": "16f34355-3726-44b8-9c29-cb594f566783", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-16f34355-3726-44b8-9c29-cb594f566783" }, { "name": "wallet_accounts", "item": [ { "name": "Show the Wallet Account of a Sub-wallet", "id": "9c7fee79-054f-4c85-b14f-9232d0278611", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id/wallet_accounts", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "wallet_accounts" ], "variable": [ { "id": "eb273bb5-9aaf-44ea-8e7e-bb8f7cb24af0", "key": "id", "value": "c66a1bec-4ca5-418c-8b0a-5513819576ee", "description": "(Required) sub-wallet ID" } ] }, "description": "Show the details of the wallet account that a sub-wallet is associated with using the given `:id`." }, "response": [ { "id": "7a22135b-71b2-4ae5-b6c0-714dc511771b", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id/wallet_accounts", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "wallet_accounts" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"wallet_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"not_verified\",\n \"balance\": \"\",\n \"links\": {\n \"self\": {},\n \"users\": {},\n \"batch_transactions\": {},\n \"transactions\": {},\n \"bpay_details\": {},\n \"npp_details\": {},\n \"virtual_accounts\": {}\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-7a22135b-71b2-4ae5-b6c0-714dc511771b" }, { "id": "abb48604-9397-4376-b48c-2b8e35687e75", "name": "unprocessable content", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id/wallet_accounts", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id", "wallet_accounts" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"field\": {}\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-abb48604-9397-4376-b48c-2b8e35687e75" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9c7fee79-054f-4c85-b14f-9232d0278611" } ], "id": "81f1b870-b2b0-48f1-84c8-443a2db51d5c", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-81f1b870-b2b0-48f1-84c8-443a2db51d5c" }, { "name": "Show Sub-wallet", "id": "9d45a01f-c342-4135-b095-d0624284ab25", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id" ], "variable": [ { "id": "f6bd910b-410b-4715-ba68-774318611acf", "key": "id", "value": "c66a1bec-4ca5-418c-8b0a-5513819576ee", "description": "(Required) sub-wallet ID" } ] }, "description": "Show details of a specific sub-wallet using the given`:id`." }, "response": [ { "id": "e6667c9a-efe7-4d93-ab48-6f4dd7ea3620", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sub_wallets\": {\n \"id\": \"\",\n \"name\": \"\",\n \"balance\": \"\",\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"currency\": \"\",\n \"links\": {\n \"self\": {},\n \"users\": {},\n \"transactions\": {},\n \"wallet_accounts\": {}\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-e6667c9a-efe7-4d93-ab48-6f4dd7ea3620" }, { "id": "70eb3838-ad21-43ae-861d-a2bbd24997c5", "name": "unprocessable content", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"field\": {}\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-70eb3838-ad21-43ae-861d-a2bbd24997c5" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9d45a01f-c342-4135-b095-d0624284ab25" }, { "name": "Redact Sub-wallet", "id": "2382efbe-ee1a-4ed9-b6bd-c932a2ebd713", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id" ], "variable": [ { "id": "51458e59-9875-49e0-9829-26809e059113", "key": "id", "value": "c66a1bec-4ca5-418c-8b0a-5513819576ee", "description": "(Required) sub-wallet ID" } ] }, "description": "Redact a sub-wallet using the given `:id`. Only sub-wallets with zero balance can be redacted. Once this is done, the sub-wallet can no longer be used as a funding source." }, "response": [ { "id": "af477277-5c0e-40a3-bead-2d35c59eabe9", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sub_wallets\": {\n \"id\": \"\",\n \"name\": \"\",\n \"balance\": \"\",\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"currency\": \"\",\n \"links\": {\n \"self\": {},\n \"users\": {},\n \"transactions\": {},\n \"wallet_accounts\": {}\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-af477277-5c0e-40a3-bead-2d35c59eabe9" }, { "id": "18c88f51-4f03-4183-9784-5bce0fd1e5fd", "name": "unprocessable content", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/sub_wallets/:id", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"field\": {}\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-18c88f51-4f03-4183-9784-5bce0fd1e5fd" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2382efbe-ee1a-4ed9-b6bd-c932a2ebd713" }, { "name": "Update Sub-wallet", "id": "a38f0563-7a70-4173-8ccd-7419d14ccbbb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Investment Fund\",\n \"active\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets/:id", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id" ], "variable": [ { "id": "6cc58e89-8d39-44fc-92f2-2729d34cb80a", "key": "id", "value": "c66a1bec-4ca5-418c-8b0a-5513819576ee", "description": "(Required) sub-wallet ID" } ] }, "description": "Update an existing sub-wallet using the given `:id`. You can change the `name` of an enabled sub-wallet. You can change the `active` status of a `redacted` sub-wallet." }, "response": [ { "id": "72327cc6-a1c1-455f-897f-09574c8a16ce", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Investment Fund\",\n \"active\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets/:id", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sub_wallets\": {\n \"id\": \"\",\n \"name\": \"\",\n \"balance\": \"\",\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"currency\": \"\",\n \"links\": {\n \"self\": {},\n \"users\": {},\n \"transactions\": {},\n \"wallet_accounts\": {}\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-72327cc6-a1c1-455f-897f-09574c8a16ce" }, { "id": "3a1da10d-3b26-43c7-bf99-79617fc1f128", "name": "unprocessable content", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Investment Fund\",\n \"active\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets/:id", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"field\": {}\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-3a1da10d-3b26-43c7-bf99-79617fc1f128" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a38f0563-7a70-4173-8ccd-7419d14ccbbb" } ], "id": "283a50a2-da07-4f8e-a081-122c8bb34ee9", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-283a50a2-da07-4f8e-a081-122c8bb34ee9" }, { "name": "transfer", "item": [ { "name": "Fund transfers", "id": "b1f0cc43-0b83-4474-9805-dfdfe9fa5116", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"source\": \"31b9e5ec-06d3-41e7-bc3b-a2c18890add6\",\n \"destination\": \"3eb78280-b8b6-013a-c1b7-5e50adfe91ad\",\n \"amount\": 1000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets/transfer", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", "transfer" ] }, "description": "Fund transfers between a wallet account and its sub-wallet as well as between any sub-wallets that belong to the same wallet account. The `source` and `destination` accounts must be `active` and use the same currency." }, "response": [ { "id": "f84e60d9-7885-4196-b6fc-7eb26123498b", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"source\": \"31b9e5ec-06d3-41e7-bc3b-a2c18890add6\",\n \"destination\": \"3eb78280-b8b6-013a-c1b7-5e50adfe91ad\",\n \"amount\": 1000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets/transfer", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", "transfer" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"sub_wallets_id\": \"\",\n \"sub_wallet_name\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"debit_credit\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\"\n },\n \"related\": {\n \"transactions\": [\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\"\n }\n ]\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-f84e60d9-7885-4196-b6fc-7eb26123498b" }, { "id": "b5323253-cc71-4371-bf88-d8b497c691a2", "name": "unprocessable content", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"source\": \"31b9e5ec-06d3-41e7-bc3b-a2c18890add6\",\n \"destination\": \"3eb78280-b8b6-013a-c1b7-5e50adfe91ad\",\n \"amount\": 1000\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets/transfer", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets", "transfer" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"field\": {}\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b5323253-cc71-4371-bf88-d8b497c691a2" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b1f0cc43-0b83-4474-9805-dfdfe9fa5116" } ], "id": "8b83f74b-f4db-41fc-855d-8d8ed5ad51ce", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-8b83f74b-f4db-41fc-855d-8d8ed5ad51ce" }, { "name": "Create Sub-wallet", "id": "9f5bdc46-1404-49a8-8012-b645bd98850f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"86991380-90a5-013a-57cc-5e50adfe91ad\",\n \"name\": \"Investment Fund\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets" ] }, "description": "Create a sub-wallet for a user's wallet account.This is specified by the wallet `account_id`. Use sub-wallets as a part of building your own scheduling and workflow. Create as many as you want to manage, with no limits to the amount." }, "response": [ { "id": "ce09df57-f93d-45c4-89be-ed193fe15aa0", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"86991380-90a5-013a-57cc-5e50adfe91ad\",\n \"name\": \"Investment Fund\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sub_wallets\": {\n \"id\": \"\",\n \"name\": \"\",\n \"balance\": \"\",\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"currency\": \"\",\n \"links\": {\n \"self\": {},\n \"users\": {},\n \"wallet_accounts\": {}\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ce09df57-f93d-45c4-89be-ed193fe15aa0" }, { "id": "42dc0b28-df7e-4fec-b353-1081f5575c69", "name": "unprocessable content", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"86991380-90a5-013a-57cc-5e50adfe91ad\",\n \"name\": \"Investment Fund\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/sub_wallets", "host": [ "{{baseUrl}}" ], "path": [ "sub_wallets" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"field\": {}\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-42dc0b28-df7e-4fec-b353-1081f5575c69" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9f5bdc46-1404-49a8-8012-b645bd98850f" } ], "id": "3a2212d1-2956-4be9-9114-b61888b0180c", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-3a2212d1-2956-4be9-9114-b61888b0180c" }, { "name": "users", "item": [ { "name": "{id}", "item": [ { "name": "bpay_accounts", "item": [ { "name": "List User's BPay Accounts", "id": "25f86299-c96c-4445-b3f8-c1058aa18769", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:id/bpay_accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "bpay_accounts" ], "variable": [ { "id": "6d65cffc-1a3d-49ff-aaf5-0464d95e66e3", "key": "id", "value": "901d8cd0-6af3-0138-967d-0a58a9feac04", "description": "(Required) User ID" } ] }, "description": "List the **BPay Accounts** the **User** is associated with using a given `:id`." }, "response": [ { "id": "4fe039d3-9c90-4678-b051-dab21caaccd9", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/users/:id/bpay_accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "bpay_accounts" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bpay_accounts\": [\n {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"verified\",\n \"bpay_details\": {\n \"account_name\": \"\",\n \"biller_code\": \"\",\n \"biller_name\": \"\",\n \"crn\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\"\n }\n },\n {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"verified\",\n \"bpay_details\": {\n \"account_name\": \"\",\n \"biller_code\": \"\",\n \"biller_name\": \"\",\n \"crn\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\"\n }\n }\n ],\n \"links\": {\n \"self\": \"\"\n },\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4fe039d3-9c90-4678-b051-dab21caaccd9" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-25f86299-c96c-4445-b3f8-c1058aa18769" } ], "id": "0cf33bbc-77d9-48fc-9f5a-64cca7f9b721", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-0cf33bbc-77d9-48fc-9f5a-64cca7f9b721" }, { "name": "card_accounts", "item": [ { "name": "Show User Card Account", "id": "13747f36-8c4c-462b-a7ce-e55d231b32ed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:id/card_accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "card_accounts" ], "variable": [ { "id": "a18305bf-ee70-48d2-ac13-c43f60330337", "key": "id", "value": "buyer-71439598", "description": "(Required) User ID" } ] }, "description": "Show the user's active card account using a given `:id`." }, "response": [ { "id": "92b73688-c4d1-409b-b59f-85a95b76063c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/users/:id/card_accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "card_accounts" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"card_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"cvv_verified\": \"\",\n \"verification_status\": \"verified\",\n \"card\": {\n \"type\": \"\",\n \"full_name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"\",\n \"expiry_year\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-92b73688-c4d1-409b-b59f-85a95b76063c" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-13747f36-8c4c-462b-a7ce-e55d231b32ed" } ], "id": "563f8862-b463-4c47-81ad-1eb448126e87", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-563f8862-b463-4c47-81ad-1eb448126e87" }, { "name": "identity_verified", "item": [ { "name": "Verify User (Prelive Only)", "id": "94f354a2-27b4-4261-babf-1a25330231fc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:id/identity_verified", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "identity_verified" ], "variable": [ { "id": "2a5c7537-1cfc-41d3-b530-001a937c1521", "key": "id", "value": "buyer-1556506027", "description": "(Required) User ID" } ] }, "description": "Sets a user's verification state to `approved` on pre-live given the **User** `:id`. Ensure that a **User** has the required user verification information before using this call, otherwise the call will fail. **Note**: This API call will only work in our pre-live environment. The user verification workflow holds for all users in production.\n" }, "response": [ { "id": "2be3f339-9970-4edd-baec-7f21dddfcb04", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/users/:id/identity_verified", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "identity_verified" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2be3f339-9970-4edd-baec-7f21dddfcb04" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-94f354a2-27b4-4261-babf-1a25330231fc" } ], "id": "02e71cb9-d36d-474c-b607-5d14f203e37d", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-02e71cb9-d36d-474c-b607-5d14f203e37d" }, { "name": "bank_accounts", "item": [ { "name": "Show User Bank Account", "id": "4886eb79-c843-4b26-870c-edc84543662c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:id/bank_accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "bank_accounts" ], "variable": [ { "id": "31f6a86f-5174-453d-a982-565b46928fa1", "key": "id", "value": "46deb476-c1a6-41eb-8eb7-26a695bbe5bc", "description": "(Required) User ID" } ] }, "description": "Shows the user's active bank account using a given `:id`." }, "response": [ { "id": "c5b1973a-f316-42d3-963a-ec66aa46525d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/users/:id/bank_accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "bank_accounts" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bank_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"not_verified\",\n \"verification\": {\n \"verified_at\": \"\",\n \"verification_method\": \"COP\",\n \"result\": {\n \"match_result\": \"NMTO\"\n }\n },\n \"bank\": {\n \"bank_name\": \"\",\n \"country\": \"\",\n \"account_name\": \"\",\n \"routing_number\": \"\",\n \"account_number\": \"\",\n \"holder_type\": \"business\",\n \"account_type\": \"savings\",\n \"direct_debit_authority_status\": \"null\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"direct_debit_authorities\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-c5b1973a-f316-42d3-963a-ec66aa46525d" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4886eb79-c843-4b26-870c-edc84543662c" } ], "id": "2ad446c1-89b1-4dfa-b625-fbac5acd5657", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2ad446c1-89b1-4dfa-b625-fbac5acd5657" }, { "name": "disbursement_account", "item": [ { "name": "Set User Disbursement Account", "id": "a6c0d96a-b706-4189-a4f1-c60c9e9ec856", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"901d8cd0-6af3-0138-967d-0a58a9feac04\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:id/disbursement_account", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "disbursement_account" ], "variable": [ { "id": "04d7c576-a7e6-48f6-9296-5e7a6c0f3d90", "key": "id", "value": "Seller_1234", "description": "(Required) User ID" } ] }, "description": "Set the **User's Disbursement Account** using a given **User** `:id` and a **Bank Account** `:account_id`." }, "response": [ { "id": "d0099f5f-ca8a-4edc-b51e-8605c048222e", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"901d8cd0-6af3-0138-967d-0a58a9feac04\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:id/disbursement_account", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "disbursement_account" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d0099f5f-ca8a-4edc-b51e-8605c048222e" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a6c0d96a-b706-4189-a4f1-c60c9e9ec856" } ], "id": "2547f9ce-f058-4bec-aa0f-fd1c878dbbe1", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2547f9ce-f058-4bec-aa0f-fd1c878dbbe1" }, { "name": "items", "item": [ { "name": "List User Items", "id": "b678b6a7-b3cf-4d47-83bd-b5d9bf83b70f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:id/items?offset=0&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "items" ], "query": [ { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" } ], "variable": [ { "id": "6dc9c893-9b5d-4758-958b-b4c49fbdae38", "key": "id", "value": "test-user-1592459047-22", "description": "(Required) User ID" } ] }, "description": "Retrieve an ordered and paginated list of existing **Items** the **User** is associated with using a given `:id`." }, "response": [ { "id": "d33b2da3-ba83-4fe8-ab70-2418a3881eff", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/users/:id/items?offset=0&limit=10", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "items" ], "query": [ { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"payment_held\",\n \"status\": 22400,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"partial_paid\",\n \"status\": 22500,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n ],\n \"links\": {\n \"self\": \"\"\n },\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d33b2da3-ba83-4fe8-ab70-2418a3881eff" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b678b6a7-b3cf-4d47-83bd-b5d9bf83b70f" } ], "id": "ec227593-a834-41db-a223-7db0b40e11f8", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ec227593-a834-41db-a223-7db0b40e11f8" }, { "name": "wallet_accounts", "item": [ { "name": "Show User Wallet Account", "id": "8f9f9465-6a59-497b-910e-51782b2edadd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:id/wallet_accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "wallet_accounts" ], "variable": [ { "id": "d9fa8a68-c8c7-4adb-b701-a75611997604", "key": "id", "value": "aed45af0-6f63-0138-901c-0a58a9feac03", "description": "(Required) User ID" } ] }, "description": "Show the **User's Wallet Account** using a given `:id`." }, "response": [ { "id": "a3617f23-8221-44aa-b2da-f321e81068a1", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/users/:id/wallet_accounts", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id", "wallet_accounts" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"wallet_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"not_verified\",\n \"balance\": \"\",\n \"links\": {\n \"self\": {},\n \"users\": {},\n \"batch_transactions\": {},\n \"transactions\": {},\n \"bpay_details\": {},\n \"npp_details\": {},\n \"virtual_accounts\": {}\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a3617f23-8221-44aa-b2da-f321e81068a1" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-8f9f9465-6a59-497b-910e-51782b2edadd" } ], "id": "a9ff9106-2396-41e6-b4d7-38e75f8f32c1", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a9ff9106-2396-41e6-b4d7-38e75f8f32c1" }, { "name": "Show User", "id": "d0266178-b85a-4088-8e58-6c98da36d71b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "id": "bca332ab-7bf2-4d52-8ded-41f32b7bad04", "key": "id", "value": "buyer-1556506027", "description": "(Required) User ID" } ] }, "description": "Show details of a specific User using a given `:id`." }, "response": [ { "id": "98ebf830-c377-4546-876a-dc5349c33c17", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-98ebf830-c377-4546-876a-dc5349c33c17" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d0266178-b85a-4088-8e58-6c98da36d71b" }, { "name": "Update User", "id": "7bcd89f2-5f45-40f2-bbdd-b51688c1046d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Neol1556506027\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license_number\": \"\",\n \"drivers_license_state\": \"\",\n \"ip_address\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"custom_descriptor\": \"\",\n \"authorized_signer_title\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "id": "59aec011-b4fc-470b-8105-b99a91d076b4", "key": "id", "value": "buyer-1556506027", "description": "(Required) Unique ID that can be generated by the platform. Cannot contain '.' character." } ] }, "description": "Update an existing **User's** attributes using a given `:id`." }, "response": [ { "id": "49444d23-000f-4c88-878b-1c6948af06eb", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Neol1556506027\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"country\": \"\",\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license_number\": \"\",\n \"drivers_license_state\": \"\",\n \"ip_address\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"custom_descriptor\": \"\",\n \"authorized_signer_title\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users/:id", "host": [ "{{baseUrl}}" ], "path": [ "users", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-49444d23-000f-4c88-878b-1c6948af06eb" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-7bcd89f2-5f45-40f2-bbdd-b51688c1046d" } ], "id": "7125a605-a3c7-49da-a3e8-f9866357322d", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-7125a605-a3c7-49da-a3e8-f9866357322d" }, { "name": "List Users", "id": "72628c38-202f-4ab5-a561-160aa84d41d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/users?limit=10&offset=0&search=", "host": [ "{{baseUrl}}" ], "path": [ "users" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "(Required) A text value to be used for searching users", "key": "search", "value": "" } ] }, "description": "Retrieve an ordered and paginated list of existing **Users**." }, "response": [ { "id": "a50d24fc-80ac-43f2-a5f3-62c429a29d1f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/users?limit=10&offset=0&search=", "host": [ "{{baseUrl}}" ], "path": [ "users" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "(Required) A text value to be used for searching users", "key": "search", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": [\n {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n },\n {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a50d24fc-80ac-43f2-a5f3-62c429a29d1f" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-72628c38-202f-4ab5-a561-160aa84d41d9" }, { "name": "Create User", "id": "f68a7b90-5a27-4b9a-930b-9e591b3becc3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"buyer-1556506027\",\n \"first_name\": \"Neol1556506027\",\n \"last_name\": \"Calangi\",\n \"email\": \"neol.calangi+buyer1556506027@promisepay.com\",\n \"country\": \"AUS\",\n \"mobile\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license_number\": \"\",\n \"drivers_license_state\": \"\",\n \"ip_address\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"custom_descriptor\": \"\",\n \"authorized_signer_title\": \"\",\n \"company\": {\n \"country\": \"AUS\",\n \"legal_name\": \"ABC Pty Ltd\",\n \"name\": \"ABC\",\n \"tax_number\": \"123456789\",\n \"business_email\": \"\",\n \"charge_tax\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"phone\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ] }, "description": "Create a **User** that can be associated with **Items** as either a buyer or a seller. **Users** can't be both the buyer and seller for the same **Item**. You can also use this endpoint to create a **company** for the user. To create a company for the user, you need to send company parameters in the same request. **Note**: Some parameters are required for user verification. See our guide on [Onboarding a Payout User/Seller](https://developer.hellozai.com/docs/onboarding-a-pay-out-user) for more information.\n" }, "response": [ { "id": "b503c751-fa2a-48ba-bccb-639fe372cd9c", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"buyer-1556506027\",\n \"first_name\": \"Neol1556506027\",\n \"last_name\": \"Calangi\",\n \"email\": \"neol.calangi+buyer1556506027@promisepay.com\",\n \"country\": \"AUS\",\n \"mobile\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"state\": \"\",\n \"city\": \"\",\n \"zip\": \"\",\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license_number\": \"\",\n \"drivers_license_state\": \"\",\n \"ip_address\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"custom_descriptor\": \"\",\n \"authorized_signer_title\": \"\",\n \"company\": {\n \"country\": \"AUS\",\n \"legal_name\": \"ABC Pty Ltd\",\n \"name\": \"ABC\",\n \"tax_number\": \"123456789\",\n \"business_email\": \"\",\n \"charge_tax\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"phone\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/users", "host": [ "{{baseUrl}}" ], "path": [ "users" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b503c751-fa2a-48ba-bccb-639fe372cd9c" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-f68a7b90-5a27-4b9a-930b-9e591b3becc3" } ], "id": "36fc0ad0-21cb-4df5-b46e-633b46b63473", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-36fc0ad0-21cb-4df5-b46e-633b46b63473" }, { "name": "callbacks", "item": [ { "name": "{id}", "item": [ { "name": "responses", "item": [ { "name": "List Callback Responses", "id": "dd263d16-46e1-432d-866a-29dde0db4c8c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/callbacks/:id/responses?limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "callbacks", ":id", "responses" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" } ], "variable": [ { "id": "6ffb5c14-a336-43aa-90e6-372ea11b6ef8", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) Callback ID" } ] }, "description": "Retrieve an ordered and paginated list of the responses garnered from a callback using a given `:id`." }, "response": [ { "id": "2ca84a37-912f-4528-aa46-16fa7369984f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/callbacks/:id/responses?limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "callbacks", ":id", "responses" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"callback_responses\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"created_at\": \"\",\n \"payload\": {\n \"message\": \"\"\n },\n \"response\": {\n \"error\": \"\"\n },\n \"response_code\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"created_at\": \"\",\n \"payload\": {\n \"message\": \"\"\n },\n \"response\": {\n \"error\": \"\"\n },\n \"response_code\": \"\"\n }\n ],\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"callbacks\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2ca84a37-912f-4528-aa46-16fa7369984f" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-dd263d16-46e1-432d-866a-29dde0db4c8c" } ], "id": "f469a8f5-90aa-4ac6-989b-3566c02c4834", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-f469a8f5-90aa-4ac6-989b-3566c02c4834" }, { "name": "Show Callback", "id": "06faaebf-f6f3-4e5d-ab2a-c8136fa143db", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/callbacks/:id", "host": [ "{{baseUrl}}" ], "path": [ "callbacks", ":id" ], "variable": [ { "id": "ebfbc15b-f095-49e5-96ec-da4cf0f4f4c4", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) Callback ID" } ] }, "description": "Show details of a specific **Callback** using a given `:id`." }, "response": [ { "id": "da55d03c-00a0-4d28-80e6-c2ee1dddd8ce", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/callbacks/:id", "host": [ "{{baseUrl}}" ], "path": [ "callbacks", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"callbacks\": {\n \"id\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"object_type\": \"Users\",\n \"enabled\": \"\",\n \"authorization_token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"marketplace_id\": \"\",\n \"links\": {\n \"self\": \"\",\n \"responses\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-da55d03c-00a0-4d28-80e6-c2ee1dddd8ce" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-06faaebf-f6f3-4e5d-ab2a-c8136fa143db" }, { "name": "Delete Callback", "id": "506929d7-b5d2-4854-b381-90e48b6b8faa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/callbacks/:id", "host": [ "{{baseUrl}}" ], "path": [ "callbacks", ":id" ], "variable": [ { "id": "dfc048e8-1f7b-4a60-a892-f6e1be9a1199", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) Callback ID" } ] }, "description": "Delete an existing Callback using a given `:id`." }, "response": [ { "id": "7e23dedf-0f44-4d84-808a-20e86e1923c7", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/callbacks/:id", "host": [ "{{baseUrl}}" ], "path": [ "callbacks", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"callbacks\": \"\"\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-7e23dedf-0f44-4d84-808a-20e86e1923c7" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-506929d7-b5d2-4854-b381-90e48b6b8faa" }, { "name": "Update Callback", "id": "ab3f6ad5-b784-44f1-9a94-4bd783de3b88", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://httpbin.org\",\n \"object_type\": \"users\",\n \"enabled\": \"true\",\n \"description\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/callbacks/:id", "host": [ "{{baseUrl}}" ], "path": [ "callbacks", ":id" ], "variable": [ { "id": "01ec0c2f-fa31-4cae-8506-f703809a4128", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) Callback ID" } ] }, "description": "Update an existing **Callback** using a given `:id`. You can change the `URL`, the `object_type` and whether the **Callback** is `enabled` or `disabled`.\n" }, "response": [ { "id": "58b01792-1c1b-485b-9c2d-3c7680febd9a", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://httpbin.org\",\n \"object_type\": \"users\",\n \"enabled\": \"true\",\n \"description\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/callbacks/:id", "host": [ "{{baseUrl}}" ], "path": [ "callbacks", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"callbacks\": {\n \"id\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"object_type\": \"Users\",\n \"enabled\": \"\",\n \"authorization_token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"marketplace_id\": \"\",\n \"links\": {\n \"self\": \"\",\n \"responses\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-58b01792-1c1b-485b-9c2d-3c7680febd9a" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ab3f6ad5-b784-44f1-9a94-4bd783de3b88" } ], "id": "aad5324d-2489-45fb-a576-a40b26bf849f", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-aad5324d-2489-45fb-a576-a40b26bf849f" }, { "name": "{callback_id}", "item": [ { "name": "responses", "item": [ { "name": "{id}", "item": [ { "name": "Show Callback Response", "id": "f5edabe3-c85c-4278-9312-2e8d68ce5230", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/callbacks/:callback_id/responses/:id", "host": [ "{{baseUrl}}" ], "path": [ "callbacks", ":callback_id", "responses", ":id" ], "variable": [ { "id": "c125bd38-41d9-4d5e-bc48-47d9b9e6c08c", "key": "callback_id", "value": "088e4cf1-2508-4bd4-97ab-a78e4e869970", "description": "(Required) Callback ID" }, { "id": "0d4397c8-4669-4dbf-8208-5efff0e76da5", "key": "id", "value": "0c9cbb28-0b98-4560-9c81-7a4ea6cde95b", "description": "(Required) Callback response ID" } ] }, "description": "Show details of a specific **Callback** response using a given `:id`." }, "response": [ { "id": "193454ec-4dd5-4873-a824-7fbb9d0d7ab2", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/callbacks/:callback_id/responses/:id", "host": [ "{{baseUrl}}" ], "path": [ "callbacks", ":callback_id", "responses", ":id" ], "variable": [ { "key": "callback_id" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"call_responses\": {\n \"id\": \"\",\n \"url\": \"\",\n \"created_at\": \"\",\n \"payload\": {\n \"message\": \"\"\n },\n \"response\": {\n \"error\": \"\"\n },\n \"response_code\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-193454ec-4dd5-4873-a824-7fbb9d0d7ab2" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-f5edabe3-c85c-4278-9312-2e8d68ce5230" } ], "id": "226c45fa-0dce-468b-ac86-3995e3c7c1ba", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-226c45fa-0dce-468b-ac86-3995e3c7c1ba" } ], "id": "e5537227-45f0-4fd6-bdca-c45c1f1822e0", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-e5537227-45f0-4fd6-bdca-c45c1f1822e0" } ], "id": "9a524292-7af8-4ca9-b55b-14cb6ada25cf", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9a524292-7af8-4ca9-b55b-14cb6ada25cf" }, { "name": "List Callbacks", "id": "e4df53e1-16b1-4e30-9d25-90cb6b40e8eb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/callbacks?limit=10&offset=0&filter=", "host": [ "{{baseUrl}}" ], "path": [ "callbacks" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Narrow down records to relevant character string", "key": "filter", "value": "" } ] }, "description": "Retrieve an ordered and paginated list of all created **Callbacks**." }, "response": [ { "id": "d9f6bff0-6cad-4613-8da1-5cfa63ce0b59", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/callbacks?limit=10&offset=0&filter=", "host": [ "{{baseUrl}}" ], "path": [ "callbacks" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Narrow down records to relevant character string", "key": "filter", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"callbacks\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"object_type\": \"Disbursements\",\n \"enabled\": \"\",\n \"authorization_token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"marketplace_id\": \"\",\n \"links\": {\n \"self\": \"\",\n \"responses\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"object_type\": \"Accounts\",\n \"enabled\": \"\",\n \"authorization_token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"marketplace_id\": \"\",\n \"links\": {\n \"self\": \"\",\n \"responses\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d9f6bff0-6cad-4613-8da1-5cfa63ce0b59" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-e4df53e1-16b1-4e30-9d25-90cb6b40e8eb" }, { "name": "Create Callback", "id": "536e622c-4fd3-4625-815f-c0836276aa5f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://httpbin.org\",\n \"object_type\": \"users\",\n \"enabled\": \"true\",\n \"description\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/callbacks", "host": [ "{{baseUrl}}" ], "path": [ "callbacks" ] }, "description": "Create a **Callback** to notify you at the `URL` when the `object_type` changes" }, "response": [ { "id": "0c0b72af-9fca-4991-8790-4b7e5078b004", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://httpbin.org\",\n \"object_type\": \"users\",\n \"enabled\": \"true\",\n \"description\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/callbacks", "host": [ "{{baseUrl}}" ], "path": [ "callbacks" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"callbacks\": {\n \"id\": \"\",\n \"description\": \"\",\n \"url\": \"\",\n \"object_type\": \"Users\",\n \"enabled\": \"\",\n \"authorization_token\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"marketplace_id\": \"\",\n \"links\": {\n \"self\": \"\",\n \"responses\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-0c0b72af-9fca-4991-8790-4b7e5078b004" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-536e622c-4fd3-4625-815f-c0836276aa5f" } ], "id": "92157fca-4901-4cc8-a0c8-7d09352ba0fe", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-92157fca-4901-4cc8-a0c8-7d09352ba0fe" }, { "name": "card_accounts", "item": [ { "name": "{id}", "item": [ { "name": "users", "item": [ { "name": "Show Card Account User", "id": "a3b4771d-9a93-47b2-a23c-07b8a17e7643", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/card_accounts/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "card_accounts", ":id", "users" ], "variable": [ { "id": "dc29155c-4d45-47f2-a0ad-7d6c8e873230", "key": "id", "value": "901d8cd0-6af3-0138-967d-0a58a9feac04", "description": "(Required) Card account ID" } ] }, "description": "Show the **User** the Credit **Card Account** is associated with using a given `:id`." }, "response": [ { "id": "c60a0163-d3cd-468f-8f61-cfcb61006c8d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/card_accounts/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "card_accounts", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-c60a0163-d3cd-468f-8f61-cfcb61006c8d" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a3b4771d-9a93-47b2-a23c-07b8a17e7643" } ], "id": "be1f4b7d-14bc-4c05-a073-13f592f55da1", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-be1f4b7d-14bc-4c05-a073-13f592f55da1" }, { "name": "verify", "item": [ { "name": "Verify Card", "id": "8f82b0ca-72f1-453d-b499-844c6f691447", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cvv\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/card_accounts/:id/verify", "host": [ "{{baseUrl}}" ], "path": [ "card_accounts", ":id", "verify" ], "variable": [ { "id": "0efdb160-6d97-403b-b7f4-9fc1449150e6", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) Card account ID" } ] }, "description": "Where pre-authorization is enabled on a platform, verifies a **Card Account** when a **Card Account** is successfully verified, its verification status is `verified`." }, "response": [ { "id": "81dae56c-a488-4ea3-831b-cdfd01e44267", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"cvv\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/card_accounts/:id/verify", "host": [ "{{baseUrl}}" ], "path": [ "card_accounts", ":id", "verify" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"card_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"cvv_verified\": \"\",\n \"verification_status\": \"verified\",\n \"card\": {\n \"type\": \"\",\n \"full_name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"\",\n \"expiry_year\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-81dae56c-a488-4ea3-831b-cdfd01e44267" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-8f82b0ca-72f1-453d-b499-844c6f691447" } ], "id": "1e915e27-a69c-4c22-baf5-cbe3dbc61c8d", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-1e915e27-a69c-4c22-baf5-cbe3dbc61c8d" }, { "name": "Show Card Account", "id": "f37c6a36-4e03-4559-8dd5-e1729614ab87", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/card_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "card_accounts", ":id" ], "variable": [ { "id": "63908582-1d3c-4463-a6a3-bfdc84be5d45", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) Card account ID" } ] }, "description": "Show details of a specific Credit **Card Account** using a given `:id`. You can toggle the card account number display to show the first 6 digits in addition to the last 4 digits. Contact Assembly if you want to toggle the card account display.\n" }, "response": [ { "id": "bd7e69d4-6bee-473a-9958-f19d3f9ca099", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/card_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "card_accounts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"card_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"cvv_verified\": \"\",\n \"verification_status\": \"verified\",\n \"card\": {\n \"type\": \"\",\n \"full_name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"\",\n \"expiry_year\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-bd7e69d4-6bee-473a-9958-f19d3f9ca099" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-f37c6a36-4e03-4559-8dd5-e1729614ab87" }, { "name": "Redact Card Account", "id": "3908b50f-b1a4-4cac-94a8-b0858b0fdc83", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/card_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "card_accounts", ":id" ], "variable": [ { "id": "f98e8b51-fdad-4087-92b0-5c3d3a8a12d6", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) ID of the card account to be deleted" } ] }, "description": "Redact a Credit **Card Account** using a given `:id`. Redacted Credit **Card Accounts** can no longer be used as a funding source.\n" }, "response": [ { "id": "9df0facc-bf44-4da1-8da1-7a6b0b5730d7", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/card_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "card_accounts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"card_account\": \"\"\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9df0facc-bf44-4da1-8da1-7a6b0b5730d7" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-3908b50f-b1a4-4cac-94a8-b0858b0fdc83" } ], "id": "41cb0400-cfc1-44c3-aa37-e097d3161f10", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-41cb0400-cfc1-44c3-aa37-e097d3161f10" }, { "name": "Create Card Account", "id": "b9c789df-2a46-4980-aea1-8d670000d966", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"full_name\": \"John Doe\",\n \"number\": \"4444111122223333\",\n \"expiry_month\": \"1\",\n \"expiry_year\": \"2025\",\n \"cvv\": \"123\",\n \"user_id\": \"83f54680-9600-4bee-a6d1-84a5d0e10059\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/card_accounts", "host": [ "{{baseUrl}}" ], "path": [ "card_accounts" ] }, "description": "Create a Credit **Card Account** to be used as a funding source. Store the returned `:id` and use it for a `make_payment` **Item Action** call. The `:id` is also referred to as a **token** when involving Credit Cards.\n" }, "response": [ { "id": "b175f873-12e7-4e22-b0e3-e725388a22a1", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"full_name\": \"John Doe\",\n \"number\": \"4444111122223333\",\n \"expiry_month\": \"1\",\n \"expiry_year\": \"2025\",\n \"cvv\": \"123\",\n \"user_id\": \"83f54680-9600-4bee-a6d1-84a5d0e10059\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/card_accounts", "host": [ "{{baseUrl}}" ], "path": [ "card_accounts" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"card_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"cvv_verified\": \"\",\n \"verification_status\": \"verified\",\n \"card\": {\n \"type\": \"\",\n \"full_name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"\",\n \"expiry_year\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b175f873-12e7-4e22-b0e3-e725388a22a1" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b9c789df-2a46-4980-aea1-8d670000d966" } ], "id": "136666f6-6be4-46d5-9a84-93870b17bf6d", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-136666f6-6be4-46d5-9a84-93870b17bf6d" }, { "name": "companies", "item": [ { "name": "{id}", "item": [ { "name": "Show Company", "id": "bd8925fb-3c42-49fd-9e0c-15d4af2e7207", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":id" ], "variable": [ { "id": "a17d1465-0aa9-46e7-b43d-7e0863a4afe3", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) Company ID" } ] }, "description": "Show details of a specific **Company** using a given `:id`." }, "response": [ { "id": "915eebad-7c5b-4851-9d10-005b776dfb35", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"companies\": {\n \"legal_name\": \"\",\n \"name\": \"\",\n \"tax_number\": \"\",\n \"business_email\": \"\",\n \"charge_tax\": \"\",\n \"phone\": \"\",\n \"id\": \"\",\n \"related\": {\n \"address\": \"\",\n \"users\": \"\"\n },\n \"self\": {\n \"self\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-915eebad-7c5b-4851-9d10-005b776dfb35" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-bd8925fb-3c42-49fd-9e0c-15d4af2e7207" }, { "name": "Update Company", "id": "4ef080ce-d86f-4aa6-8315-3da24a5da5ee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ABC\",\n \"legal_name\": \"ABC Pty Ltd\",\n \"tax_number\": \"123456789\",\n \"country\": \"AUS\",\n \"user_id\": \"buyer-70729325\",\n \"business_email\": \"\",\n \"charge_tax\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"phone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":id" ], "variable": [ { "id": "d63b0651-81a9-4ab8-878f-2e8db1ad1a4b", "key": "id", "value": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "description": "(Required) Company ID" } ] }, "description": "Update an existing **Company** attributes using a given `:id`." }, "response": [ { "id": "b64518e3-ae76-4c81-9f75-5a15cf24dc5b", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ABC\",\n \"legal_name\": \"ABC Pty Ltd\",\n \"tax_number\": \"123456789\",\n \"country\": \"AUS\",\n \"user_id\": \"buyer-70729325\",\n \"business_email\": \"\",\n \"charge_tax\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"phone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"companies\": {\n \"legal_name\": \"\",\n \"name\": \"\",\n \"tax_number\": \"\",\n \"business_email\": \"\",\n \"charge_tax\": \"\",\n \"phone\": \"\",\n \"id\": \"\",\n \"related\": {\n \"address\": \"\",\n \"users\": \"\"\n },\n \"self\": {\n \"self\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b64518e3-ae76-4c81-9f75-5a15cf24dc5b" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4ef080ce-d86f-4aa6-8315-3da24a5da5ee" } ], "id": "765e004a-73c4-4bca-8960-f53c9ed4d66d", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-765e004a-73c4-4bca-8960-f53c9ed4d66d" }, { "name": "List Companies", "id": "4f273946-42b0-49c6-80f9-ff91a0a6081d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies?limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" } ] }, "description": "Retrieve an ordered and paginated list of existing **Companies**." }, "response": [ { "id": "3a8a8520-179c-4c57-b766-a908edb61306", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/companies?limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"companies\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"legal_name\": \"\",\n \"business_email\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"legal_name\": \"\",\n \"business_email\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-3a8a8520-179c-4c57-b766-a908edb61306" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4f273946-42b0-49c6-80f9-ff91a0a6081d" }, { "name": "Create Company", "id": "87c451f3-1ccb-439b-bf9b-f28589afe6cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ABC\",\n \"legal_name\": \"ABC Pty Ltd\",\n \"tax_number\": \"123456789\",\n \"country\": \"AUS\",\n \"user_id\": \"buyer-70729325\",\n \"business_email\": \"\",\n \"charge_tax\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"phone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies", "host": [ "{{baseUrl}}" ], "path": [ "companies" ] }, "description": "Create a **Company** associated with the **User** using a given `user_id`. **Note**: Some parameters are required for user verification. See our guide on [Onboarding a Payout User/Seller](https://developer.assemblypayments.com/docs/onboarding-a-pay-out-user) for more information.\n" }, "response": [ { "id": "89feb848-c350-41b9-b66d-8debe183b873", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ABC\",\n \"legal_name\": \"ABC Pty Ltd\",\n \"tax_number\": \"123456789\",\n \"country\": \"AUS\",\n \"user_id\": \"buyer-70729325\",\n \"business_email\": \"\",\n \"charge_tax\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"phone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/companies", "host": [ "{{baseUrl}}" ], "path": [ "companies" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"companies\": {\n \"legal_name\": \"\",\n \"name\": \"\",\n \"tax_number\": \"\",\n \"business_email\": \"\",\n \"charge_tax\": \"\",\n \"phone\": \"\",\n \"id\": \"\",\n \"related\": {\n \"address\": \"\",\n \"users\": \"\"\n },\n \"self\": {\n \"self\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-89feb848-c350-41b9-b66d-8debe183b873" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-87c451f3-1ccb-439b-bf9b-f28589afe6cf" } ], "id": "40e2a6ff-7ea6-459d-92c7-86c78808309f", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-40e2a6ff-7ea6-459d-92c7-86c78808309f" }, { "name": "direct_debit_authorities", "item": [ { "name": "{id}", "item": [ { "name": "Show Direct Debit Authority", "id": "7921a487-2060-4760-a3cb-76f84771440b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/direct_debit_authorities/:id", "host": [ "{{baseUrl}}" ], "path": [ "direct_debit_authorities", ":id" ], "variable": [ { "id": "2efdb372-ad25-4de0-8866-4e569e2194da", "key": "id", "value": "57abfd04-2ccb-4d55-8bd3-6f1a24a6ea47", "description": "(Required) Direct debit authority ID" } ] }, "description": "Show details of a specific **Direct Debit Authority** using a given `:id`." }, "response": [ { "id": "603f3c7a-3f96-4b0c-99d1-62c44ad34ba5", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/direct_debit_authorities/:id", "host": [ "{{baseUrl}}" ], "path": [ "direct_debit_authorities", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"direct_debit_authorities\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"amount\": \"\",\n \"bank_bsb\": \"\",\n \"debit_user_id\": \"\",\n \"state\": \"\",\n \"related\": {\n \"bank_accounts\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-603f3c7a-3f96-4b0c-99d1-62c44ad34ba5" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-7921a487-2060-4760-a3cb-76f84771440b" } ], "id": "426dd532-1298-4787-9340-1350fedb76c5", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-426dd532-1298-4787-9340-1350fedb76c5" }, { "name": "List Direct Debit Authorities", "id": "47984127-df75-4052-b6eb-629c09997800", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/direct_debit_authorities?account_id=a2463ce3-229b-4da1-8a07-93366c1092c9&limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "direct_debit_authorities" ], "query": [ { "description": "(Required) Bank account ID", "key": "account_id", "value": "a2463ce3-229b-4da1-8a07-93366c1092c9" }, { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" } ] }, "description": "Retrieve an ordered and paginated list of existing **Direct Debit Authorities**." }, "response": [ { "id": "0cf832ab-b045-49e5-9526-d269ab9a0f76", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/direct_debit_authorities?account_id=a2463ce3-229b-4da1-8a07-93366c1092c9&limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "direct_debit_authorities" ], "query": [ { "description": "(Required) Bank account ID", "key": "account_id", "value": "a2463ce3-229b-4da1-8a07-93366c1092c9" }, { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"direct_debit_authorities\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"amount\": \"\",\n \"bank_bsb\": \"\",\n \"debit_user_id\": \"\",\n \"state\": \"\",\n \"related\": {\n \"bank_accounts\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"amount\": \"\",\n \"bank_bsb\": \"\",\n \"debit_user_id\": \"\",\n \"state\": \"\",\n \"related\": {\n \"bank_accounts\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-0cf832ab-b045-49e5-9526-d269ab9a0f76" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-47984127-df75-4052-b6eb-629c09997800" }, { "name": "Create Direct Debit Authority", "id": "2c3cedf2-1994-4a58-a8c8-9bb5af81181f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"7fac6c60-6f5b-0138-eb9a-0a58a9feac03\",\n \"amount\": 100\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/direct_debit_authorities", "host": [ "{{baseUrl}}" ], "path": [ "direct_debit_authorities" ] }, "description": "Create a **Direct Debit Authority** associated with a **Bank Account**. The **Direct Debit Authority** is required to use a **Bank Account** as a funding source (Direct Debit/ACH).\n" }, "response": [ { "id": "2c4a8c92-77a2-489d-b48b-fd8cc5d2493d", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"7fac6c60-6f5b-0138-eb9a-0a58a9feac03\",\n \"amount\": 100\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/direct_debit_authorities", "host": [ "{{baseUrl}}" ], "path": [ "direct_debit_authorities" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"direct_debit_authorities\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"amount\": \"\",\n \"bank_bsb\": \"\",\n \"debit_user_id\": \"\",\n \"state\": \"\",\n \"related\": {\n \"bank_accounts\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2c4a8c92-77a2-489d-b48b-fd8cc5d2493d" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2c3cedf2-1994-4a58-a8c8-9bb5af81181f" } ], "id": "fb411e41-692f-4b50-9296-f12a52317e17", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-fb411e41-692f-4b50-9296-f12a52317e17" }, { "name": "fees", "item": [ { "name": "{id}", "item": [ { "name": "Show Fee", "id": "1f4799d1-aad0-4ba8-9c63-09f41545d462", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/fees/:id?item_amount=200", "host": [ "{{baseUrl}}" ], "path": [ "fees", ":id" ], "query": [ { "description": "(Required) The cost of the item in cents on which the calculated Fee is based", "key": "item_amount", "value": "200" } ], "variable": [ { "id": "bdaf4c3d-1f38-46ea-afd2-42ed42b811eb", "key": "id", "value": "1e5e372a-df3a-4f77-af2f-ec294b1715ce", "description": "(Required) Fee ID" } ] }, "description": "Show details of a specific **Fee** using a given `:id`. If the `item_amount` is specified, the response also shows the `calculated_fee` based on a percentage of the `item_amount`.\n" }, "response": [ { "id": "78292b3c-614a-42d7-a9fb-3ee2f04fc891", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/fees/:id?item_amount=200", "host": [ "{{baseUrl}}" ], "path": [ "fees", ":id" ], "query": [ { "description": "(Required) The cost of the item in cents on which the calculated Fee is based", "key": "item_amount", "value": "200" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"fees\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"name\": \"\",\n \"fee_type_id\": \"\",\n \"amount\": \"\",\n \"cap\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"to\": \"\",\n \"calculated_fee\": \"\",\n \"links\": {\n \"self\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-78292b3c-614a-42d7-a9fb-3ee2f04fc891" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-1f4799d1-aad0-4ba8-9c63-09f41545d462" } ], "id": "ee90c749-d6c4-4ee6-9ca1-eb281974ad7f", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ee90c749-d6c4-4ee6-9ca1-eb281974ad7f" }, { "name": "List Fees", "id": "b5f1c3fa-774d-4832-9be2-3beee5eb2958", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/fees?limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "fees" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" } ] }, "description": "Retrieve an ordered and paginated list of existing **Fees**." }, "response": [ { "id": "f5c072ba-69af-4503-9e43-92ebe8aeb72d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/fees?limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "fees" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"fees\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"name\": \"\",\n \"fee_type_id\": \"\",\n \"amount\": \"\",\n \"cap\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"to\": \"\",\n \"calculated_fee\": \"\",\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"name\": \"\",\n \"fee_type_id\": \"\",\n \"amount\": \"\",\n \"cap\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"to\": \"\",\n \"calculated_fee\": \"\",\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-f5c072ba-69af-4503-9e43-92ebe8aeb72d" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b5f1c3fa-774d-4832-9be2-3beee5eb2958" }, { "name": "Create fee", "id": "8cdaf80b-a8d1-4f51-86c4-e4e6f1a3d5e3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Seller Success Fee\",\n \"fee_type_id\": \"2\",\n \"amount\": 200,\n \"cap\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"to\": \"cc\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/fees", "host": [ "{{baseUrl}}" ], "path": [ "fees" ] }, "description": "Create a **Fee** to be associated with an **Item**. **Fees** will add or subtract from the **Item** amount based on the **User**, payment type or Disbursement account type. **Fees** can be `Fixed` or `Percentage` based. **Fees** can be capped, have a maximum amount and/or a minimum amount.\n" }, "response": [ { "id": "3f06a8b3-ae32-4690-914d-8e1d8718a026", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Seller Success Fee\",\n \"fee_type_id\": \"2\",\n \"amount\": 200,\n \"cap\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"to\": \"cc\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/fees", "host": [ "{{baseUrl}}" ], "path": [ "fees" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"fees\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"name\": \"\",\n \"fee_type_id\": \"\",\n \"amount\": \"\",\n \"cap\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"to\": \"\",\n \"calculated_fee\": \"\",\n \"links\": {\n \"self\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-3f06a8b3-ae32-4690-914d-8e1d8718a026" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-8cdaf80b-a8d1-4f51-86c4-e4e6f1a3d5e3" } ], "id": "ef19ea5c-cc21-44fa-ad6f-f0ac1771a2f0", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ef19ea5c-cc21-44fa-ad6f-f0ac1771a2f0" }, { "name": "charges", "item": [ { "name": "{id}", "item": [ { "name": "status", "item": [ { "name": "Show Charge Status", "id": "944ce7d0-04d4-4320-8f64-302fdbadd795", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/charges/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "charges", ":id", "status" ], "variable": [ { "id": "be27bc42-b01e-4224-af4c-0255927befab", "key": "id", "value": "1e5e372a-df3a-4f77-af2f-ec294b1715ce", "description": "(Required) Charge ID" } ] }, "description": "Show status of a specific **Charge** using a given `:id`." }, "response": [ { "id": "b6408097-77d1-46a6-aa14-fc4c54f11ec7", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/charges/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "charges", ":id", "status" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"charges\": {\n \"id\": \"\",\n \"state\": \"\",\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b6408097-77d1-46a6-aa14-fc4c54f11ec7" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-944ce7d0-04d4-4320-8f64-302fdbadd795" } ], "id": "57c7278e-3b85-42a6-a8d7-ecb91ab4a4e0", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-57c7278e-3b85-42a6-a8d7-ecb91ab4a4e0" }, { "name": "buyers", "item": [ { "name": "Show Charge Buyer", "id": "e69f569f-3a47-4df3-8279-0d1852b45385", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/charges/:id/buyers", "host": [ "{{baseUrl}}" ], "path": [ "charges", ":id", "buyers" ], "variable": [ { "id": "b9c4cd35-886d-464b-8a4d-eecdc705b28d", "key": "id", "value": "4d7d73f5-c7f0-477d-aff8-7570d2c7e7d9/buyers", "description": "(Required) Charge ID" } ] }, "description": "Show the buyer **User** associated with the **Charge** using a given `:id`." }, "response": [ { "id": "093194c5-a3ad-43ab-b723-98eb5205c304", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/charges/:id/buyers", "host": [ "{{baseUrl}}" ], "path": [ "charges", ":id", "buyers" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-093194c5-a3ad-43ab-b723-98eb5205c304" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-e69f569f-3a47-4df3-8279-0d1852b45385" } ], "id": "e7df0a7e-75b8-4861-9eb1-46228dfd9488", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-e7df0a7e-75b8-4861-9eb1-46228dfd9488" }, { "name": "Show Charge", "id": "dda73ee5-a79d-4d0c-9a51-f00411f9cb91", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/charges/:id", "host": [ "{{baseUrl}}" ], "path": [ "charges", ":id" ], "variable": [ { "id": "70fac558-cdc2-4dd7-90ee-eb6ba8db36d0", "key": "id", "value": "4d7d73f5-c7f0-477d-aff8-7570d2c7e7d9", "description": "(Required) Charge ID" } ] }, "description": "Show details of a specific **Charge** using a given `:id`." }, "response": [ { "id": "ddb481f6-ae36-4deb-ad98-4a8e8f80fe39", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/charges/:id", "host": [ "{{baseUrl}}" ], "path": [ "charges", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"charges\": {\n \"id\": \"\",\n \"name\": \"\",\n \"custom_descriptor\": \"\",\n \"custom_data\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"status\": \"\",\n \"amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"promisepay_fee\": \"\",\n \"currency\": \"\",\n \"payment_method\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_zip\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_zip\": \"\",\n \"seller_country\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ddb481f6-ae36-4deb-ad98-4a8e8f80fe39" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-dda73ee5-a79d-4d0c-9a51-f00411f9cb91" } ], "id": "cd847432-2aac-4dbf-aad2-ce88a8bcd68a", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-cd847432-2aac-4dbf-aad2-ce88a8bcd68a" }, { "name": "List Charges", "id": "4f026045-e92f-4b88-8519-eccbfd508ea7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/charges?limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "charges" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" } ] }, "description": "Retrieve an ordered and paginated list of **Charges**." }, "response": [ { "id": "c78c316e-28e0-4b24-9447-ae1a270da02f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/charges?limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "charges" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"charges\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"custom_descriptor\": \"\",\n \"custom_data\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"status\": \"\",\n \"amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"promisepay_fee\": \"\",\n \"currency\": \"\",\n \"payment_method\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_zip\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_zip\": \"\",\n \"seller_country\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"custom_descriptor\": \"\",\n \"custom_data\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"status\": \"\",\n \"amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"promisepay_fee\": \"\",\n \"currency\": \"\",\n \"payment_method\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_zip\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_zip\": \"\",\n \"seller_country\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-c78c316e-28e0-4b24-9447-ae1a270da02f" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4f026045-e92f-4b88-8519-eccbfd508ea7" }, { "name": "Create Charge", "id": "63932fbe-be0e-486e-b2ba-b684eb230c35", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"5ef44050-4c56-0137-abdf-0242ac110002\",\n \"amount\": \"1000\",\n \"email\": \"buyer-1556505753@promisepay.com\",\n \"zip\": \"3000\",\n \"country\": \"AUS\",\n \"name\": \"\",\n \"user_id\": \"\",\n \"fee_ids\": \"\",\n \"currency\": \"\",\n \"retain_account\": \"\",\n \"device_id\": \"\",\n \"ip_address\": \"\",\n \"custom_descriptor\": \"\",\n \"cvv\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/charges", "host": [ "{{baseUrl}}" ], "path": [ "charges" ] }, "description": "Create a **Charge**. **Charges** require a specified **Card Account** or **Bank Account**. You may pass through an existing **User**, or define the `user_id` of the new user that will be associated with the **Charge** and the provided Account. The `user_id` can be left blank if you wish for a new user to be created for the **Charge**, or specified if you wish for a new **User** to be created with the passed `user_id`.\n" }, "response": [ { "id": "43f6e760-34d7-48c5-94b8-55c8ae775ac4", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"5ef44050-4c56-0137-abdf-0242ac110002\",\n \"amount\": \"1000\",\n \"email\": \"buyer-1556505753@promisepay.com\",\n \"zip\": \"3000\",\n \"country\": \"AUS\",\n \"name\": \"\",\n \"user_id\": \"\",\n \"fee_ids\": \"\",\n \"currency\": \"\",\n \"retain_account\": \"\",\n \"device_id\": \"\",\n \"ip_address\": \"\",\n \"custom_descriptor\": \"\",\n \"cvv\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/charges", "host": [ "{{baseUrl}}" ], "path": [ "charges" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"charges\": {\n \"id\": \"\",\n \"name\": \"\",\n \"custom_descriptor\": \"\",\n \"custom_data\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"status\": \"\",\n \"amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"promisepay_fee\": \"\",\n \"currency\": \"\",\n \"payment_method\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_zip\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_zip\": \"\",\n \"seller_country\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-43f6e760-34d7-48c5-94b8-55c8ae775ac4" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-63932fbe-be0e-486e-b2ba-b684eb230c35" } ], "id": "315f465c-4e34-4517-868a-0d79c04e289e", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-315f465c-4e34-4517-868a-0d79c04e289e" }, { "name": "marketplace", "item": [ { "name": "Show Marketplace", "id": "7045fad4-ef07-4c49-a02b-411c597dd46f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/marketplace", "host": [ "{{baseUrl}}" ], "path": [ "marketplace" ] }, "description": "Show details of your **Platform**, providing access to your configuration and related **User** and **Company**." }, "response": [ { "id": "80e614d1-8869-455b-8a41-17403b4bc074", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/marketplace", "host": [ "{{baseUrl}}" ], "path": [ "marketplace" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"marketplaces\": {\n \"id\": \"\",\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"color_3\": \"\",\n \"color_4\": \"\",\n \"color_5\": \"\",\n \"website\": \"\",\n \"payment_frequency\": \"\",\n \"alt_marketplace_id\": \"\",\n \"state\": \"\",\n \"logo\": \"\",\n \"active\": \"\",\n \"alt_marketplace_auth\": \"\",\n \"disable_approve_logo\": \"\",\n \"enable_virtual_terminal\": \"\",\n \"currency\": \"\",\n \"email\": \"\",\n \"seller_white_labeled\": \"\",\n \"partial_refunds\": \"\",\n \"related\": {\n \"users\": \"\",\n \"company\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"principal\": \"\",\n \"company\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-80e614d1-8869-455b-8a41-17403b4bc074" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-7045fad4-ef07-4c49-a02b-411c597dd46f" } ], "id": "5ff989c5-5347-4468-844c-5ee6f30520d8", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-5ff989c5-5347-4468-844c-5ee6f30520d8" }, { "name": "token_auths", "item": [ { "name": "Generate Token", "id": "9368ce86-d82d-4fec-8c62-e0a7ad9cb35b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_type\": \"bank\",\n \"user_id\": \"seller-68611249\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/token_auths", "host": [ "{{baseUrl}}" ], "path": [ "token_auths" ] }, "description": "Create a token, either for a bank or a card account, that can be used with the **PromisePay.js** package to securely send Assembly credit card details." }, "response": [ { "id": "a31dd03c-621e-4879-86a2-b1d4b4980d64", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"token_type\": \"bank\",\n \"user_id\": \"seller-68611249\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/token_auths", "host": [ "{{baseUrl}}" ], "path": [ "token_auths" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"token_auth\": {\n \"token_type\": \"\",\n \"token\": \"\",\n \"user_id\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a31dd03c-621e-4879-86a2-b1d4b4980d64" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9368ce86-d82d-4fec-8c62-e0a7ad9cb35b" } ], "id": "62cc8877-8b5a-4a16-b2b9-bdb44f1b704f", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-62cc8877-8b5a-4a16-b2b9-bdb44f1b704f" }, { "name": "transactions", "item": [ { "name": "{id}", "item": [ { "name": "bank_accounts", "item": [ { "name": "Show Transaction Bank Account", "id": "6fa3529a-7dd7-4a51-af13-6ee81a7194cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:id/bank_accounts", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id", "bank_accounts" ], "variable": [ { "id": "bf3614cf-8ebe-4667-a170-dbd7a9740c3e", "key": "id", "value": "aed53110-6f63-0138-ea83-0a58a9feac04", "description": "(Required) Transaction ID" } ] }, "description": "Show the **Bank Account** associated with the **Transaction** using a given `:id`." }, "response": [ { "id": "a201fccc-aecb-4bc2-b920-b7540ebfaf84", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:id/bank_accounts", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id", "bank_accounts" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bank_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"not_verified\",\n \"verification\": {\n \"verified_at\": \"\",\n \"verification_method\": \"COP\",\n \"result\": {\n \"match_result\": \"NMTO\"\n }\n },\n \"bank\": {\n \"bank_name\": \"\",\n \"country\": \"\",\n \"account_name\": \"\",\n \"routing_number\": \"\",\n \"account_number\": \"\",\n \"holder_type\": \"business\",\n \"account_type\": \"savings\",\n \"direct_debit_authority_status\": \"null\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"direct_debit_authorities\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a201fccc-aecb-4bc2-b920-b7540ebfaf84" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-6fa3529a-7dd7-4a51-af13-6ee81a7194cf" } ], "id": "cf75bd19-e573-480c-ba85-a97be60abb3b", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-cf75bd19-e573-480c-ba85-a97be60abb3b" }, { "name": "card_accounts", "item": [ { "name": "Show Transaction Card Account", "id": "97e8ff97-246f-4a09-9b2c-35a42bd04bf7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:id/card_accounts", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id", "card_accounts" ], "variable": [ { "id": "7175febe-3bac-449c-ac33-82f956f11cc4", "key": "id", "value": "ea36e48a-4638-4d1a-a345-e1a0a584df8b", "description": "(Required) Transaction ID" } ] }, "description": "Show the **Card Account** associated with the **Transaction** using a given `:id`." }, "response": [ { "id": "7ff4ecd9-f99b-471a-bd58-48c1e2a612cb", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:id/card_accounts", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id", "card_accounts" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"card_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"cvv_verified\": \"\",\n \"verification_status\": \"verified\",\n \"card\": {\n \"type\": \"\",\n \"full_name\": \"\",\n \"number\": \"\",\n \"expiry_month\": \"\",\n \"expiry_year\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-7ff4ecd9-f99b-471a-bd58-48c1e2a612cb" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-97e8ff97-246f-4a09-9b2c-35a42bd04bf7" } ], "id": "4b14d66e-0c9e-4867-862b-516ac21c58a7", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4b14d66e-0c9e-4867-862b-516ac21c58a7" }, { "name": "fees", "item": [ { "name": "Show Transaction Fees", "id": "fd6b31cb-e028-45b4-8168-3e15fcb3707e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:id/fees", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id", "fees" ], "variable": [ { "id": "cf236a11-8f8b-4614-bba5-e016e7b12201", "key": "id", "value": "ea36e48a-4638-4d1a-a345-e1a0a584df8b", "description": "(Required) Transaction ID" } ] }, "description": "Show the **Fees** associated with the **Transaction** using a given `:id`." }, "response": [ { "id": "3e4d5fc2-a518-4edb-9d5c-440b4030320e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:id/fees", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id", "fees" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"fees\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"name\": \"\",\n \"fee_type_id\": \"\",\n \"amount\": \"\",\n \"cap\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"to\": \"\",\n \"calculated_fee\": \"\",\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"name\": \"\",\n \"fee_type_id\": \"\",\n \"amount\": \"\",\n \"cap\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"to\": \"\",\n \"calculated_fee\": \"\",\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-3e4d5fc2-a518-4edb-9d5c-440b4030320e" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-fd6b31cb-e028-45b4-8168-3e15fcb3707e" } ], "id": "84a64a37-c60a-4afa-a847-c0ec4ec52f74", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-84a64a37-c60a-4afa-a847-c0ec4ec52f74" }, { "name": "wallet_accounts", "item": [ { "name": "Show Transaction Wallet Account", "id": "31ba47ca-4e1a-4585-965e-657d9b8bb3f8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:id/wallet_accounts", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id", "wallet_accounts" ], "variable": [ { "id": "98ddbfcf-4282-4315-9689-ad9efacb23e6", "key": "id", "value": "ea36e48a-4638-4d1a-a345-e1a0a584df8b", "description": "(Required) Transaction ID" } ] }, "description": "Show the **Wallet Account** associated with the **Transaction** using a given `:id`." }, "response": [ { "id": "a4e85212-d9f8-4237-a92b-f469596f2f3e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:id/wallet_accounts", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id", "wallet_accounts" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"wallet_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"not_verified\",\n \"balance\": \"\",\n \"links\": {\n \"self\": {},\n \"users\": {},\n \"batch_transactions\": {},\n \"transactions\": {},\n \"bpay_details\": {},\n \"npp_details\": {},\n \"virtual_accounts\": {}\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a4e85212-d9f8-4237-a92b-f469596f2f3e" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-31ba47ca-4e1a-4585-965e-657d9b8bb3f8" } ], "id": "be33c0d1-0849-4868-8439-ba15ff0ea3ae", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-be33c0d1-0849-4868-8439-ba15ff0ea3ae" }, { "name": "users", "item": [ { "name": "Show Transaction User", "id": "7d5f6c79-b3f4-4aac-b2d5-1d9a4fd59be4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id", "users" ], "variable": [ { "id": "35e8e659-eec8-4719-ac8c-a91aeae5962a", "key": "id", "value": "901d8cd0-6af3-0138-967d-0a58a9feac04", "description": "(Required) Transaction ID" } ] }, "description": "Show the **User** associated with the **Transaction** using a given `:id`." }, "response": [ { "id": "00eb5874-30d0-429d-820e-54513b71c115", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-00eb5874-30d0-429d-820e-54513b71c115" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-7d5f6c79-b3f4-4aac-b2d5-1d9a4fd59be4" } ], "id": "15ff9eec-1545-4d52-8a09-63e54aba1fe0", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-15ff9eec-1545-4d52-8a09-63e54aba1fe0" }, { "name": "Show Transaction", "id": "eed7cc4d-9dde-4977-94a7-ae15bc09dbee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions/:id", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id" ], "variable": [ { "id": "d0a90b45-6cca-436f-9003-9e7ece3cd6ba", "key": "id", "value": "27b91b10-70eb-0138-ec44-0a58a9feac06", "description": "(Required) Transaction ID" } ] }, "description": "Show details of a specific **Transaction** using a given `:id`." }, "response": [ { "id": "62cac6c1-fb68-4896-a68e-573e6e93707f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions/:id", "host": [ "{{baseUrl}}" ], "path": [ "transactions", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"payee_name\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\",\n \"dynamic_descriptor\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"debit_credit\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\"\n },\n \"related\": {\n \"transactions\": [\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n }\n ]\n },\n \"payee_details\": {\n \"debtor_name\": \"\",\n \"debtor_legal_name\": \"\",\n \"debtor_bsb\": \"\",\n \"debtor_account\": \"\",\n \"clearing_system_transaction_id\": \"\",\n \"remittance_information\": \"\",\n \"pay_id\": \"\",\n \"pay_id_type\": \"\",\n \"end_to_end_id\": \"\",\n \"npp_payin_internal_id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"fees\": \"\",\n \"wallet_accounts\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"items\": \"\",\n \"marketplaces\": \"\",\n \"npp_payin_transaction_detail\": \"\",\n \"supplementary_data\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-62cac6c1-fb68-4896-a68e-573e6e93707f" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-eed7cc4d-9dde-4977-94a7-ae15bc09dbee" } ], "id": "1cd84c4d-72aa-4d24-9c5b-0e35ffa4ea84", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-1cd84c4d-72aa-4d24-9c5b-0e35ffa4ea84" }, { "name": "List Transactions", "id": "7ddd651d-ddaa-4b3b-abfa-09d8e93d7066", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions?limit=10&offset=0&account_id=&item_id=&transaction_type=payment&transaction_type_method=misc&direction=debit&user_id=&created_before=&created_after=", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Bank, Card or Wallet Account ID.", "key": "account_id", "value": "" }, { "description": "Item ID", "key": "item_id", "value": "" }, { "description": "The type of transaction. Options for querying are: payment, refund, disbursement, fee, deposit, withdrawal. For returned values please refer here: [Enumeration Values](https://developer.assemblypayments.com/docs/enumeration-values) for the full list", "key": "transaction_type", "value": "payment" }, { "description": "The method the transaction was carried out with. Options for querying are: credit_card, npp, bpay, wire_transfer, wallet_account_transfer, misc. For returned values please refer here: [Enumeration Values](https://developer.assemblypayments.com/docs/enumeration-values) for the full list", "key": "transaction_type_method", "value": "misc" }, { "description": "Direction of the transaction.", "key": "direction", "value": "debit" }, { "description": "User ID.", "key": "user_id", "value": "" }, { "description": "Date and time in ISO 8601 format the item(s) were created before (e.g. 2020-02-27T23:54:59Z)", "key": "created_before", "value": "" }, { "description": "Date and time in ISO 8601 format the item(s) were created after (e.g. 2020-02-27T23:54:59Z)", "key": "created_after", "value": "" } ] }, "description": "Retrieve an ordered and paginated list of **Transactions**. Note: `created_before` and `created_after` range can not be greater than 31 days" }, "response": [ { "id": "17538d3f-2090-45e8-b666-6dd181819ca3", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions?limit=10&offset=0&account_id=&item_id=&transaction_type=payment&transaction_type_method=misc&direction=debit&user_id=&created_before=&created_after=", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Bank, Card or Wallet Account ID.", "key": "account_id", "value": "" }, { "description": "Item ID", "key": "item_id", "value": "" }, { "description": "The type of transaction. Options for querying are: payment, refund, disbursement, fee, deposit, withdrawal. For returned values please refer here: [Enumeration Values](https://developer.assemblypayments.com/docs/enumeration-values) for the full list", "key": "transaction_type", "value": "payment" }, { "description": "The method the transaction was carried out with. Options for querying are: credit_card, npp, bpay, wire_transfer, wallet_account_transfer, misc. For returned values please refer here: [Enumeration Values](https://developer.assemblypayments.com/docs/enumeration-values) for the full list", "key": "transaction_type_method", "value": "misc" }, { "description": "Direction of the transaction.", "key": "direction", "value": "debit" }, { "description": "User ID.", "key": "user_id", "value": "" }, { "description": "Date and time in ISO 8601 format the item(s) were created before (e.g. 2020-02-27T23:54:59Z)", "key": "created_before", "value": "" }, { "description": "Date and time in ISO 8601 format the item(s) were created after (e.g. 2020-02-27T23:54:59Z)", "key": "created_after", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"payee_name\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\",\n \"dynamic_descriptor\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"debit_credit\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\"\n },\n \"related\": {\n \"transactions\": [\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n }\n ]\n },\n \"payee_details\": {\n \"debtor_name\": \"\",\n \"debtor_legal_name\": \"\",\n \"debtor_bsb\": \"\",\n \"debtor_account\": \"\",\n \"clearing_system_transaction_id\": \"\",\n \"remittance_information\": \"\",\n \"pay_id\": \"\",\n \"pay_id_type\": \"\",\n \"end_to_end_id\": \"\",\n \"npp_payin_internal_id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"fees\": \"\",\n \"wallet_accounts\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"items\": \"\",\n \"marketplaces\": \"\",\n \"npp_payin_transaction_detail\": \"\",\n \"supplementary_data\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"payee_name\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\",\n \"dynamic_descriptor\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"debit_credit\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\"\n },\n \"related\": {\n \"transactions\": [\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n }\n ]\n },\n \"payee_details\": {\n \"debtor_name\": \"\",\n \"debtor_legal_name\": \"\",\n \"debtor_bsb\": \"\",\n \"debtor_account\": \"\",\n \"clearing_system_transaction_id\": \"\",\n \"remittance_information\": \"\",\n \"pay_id\": \"\",\n \"pay_id_type\": \"\",\n \"end_to_end_id\": \"\",\n \"npp_payin_internal_id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"fees\": \"\",\n \"wallet_accounts\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"items\": \"\",\n \"marketplaces\": \"\",\n \"npp_payin_transaction_detail\": \"\",\n \"supplementary_data\": \"\"\n }\n }\n ],\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-17538d3f-2090-45e8-b666-6dd181819ca3" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-7ddd651d-ddaa-4b3b-abfa-09d8e93d7066" } ], "id": "1003cc24-a658-4cf5-9a9d-ec5e0cb0e9b6", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-1003cc24-a658-4cf5-9a9d-ec5e0cb0e9b6" }, { "name": "batch_transactions", "item": [ { "name": "{id}", "item": [ { "name": "Show Batch Transaction", "id": "ab27d234-2e7d-45ff-a9a2-42e75816e799", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/batch_transactions/:id", "host": [ "{{baseUrl}}" ], "path": [ "batch_transactions", ":id" ], "variable": [ { "id": "1284009b-c22c-4fc9-a209-a372df65045a", "key": "id", "value": "90c1418b-f4f4-413e-a4ba-f29c334e7f55", "description": "(Required) Transaction ID" } ] }, "description": "Get a batch transaction using its ID" }, "response": [ { "id": "f1795935-894d-4ef6-8f4c-78fe84396be4", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/batch_transactions/:id", "host": [ "{{baseUrl}}" ], "path": [ "batch_transactions", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"batch_transactions\": {\n \"id\": \"\",\n \"amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"status\": \"\",\n \"uuid\": \"\",\n \"disbursement_bank\": \"\",\n \"processing_bank\": \"\",\n \"external_reference\": \"\",\n \"reference_amount\": \"\",\n \"internal_state\": \"\",\n \"internal_status\": \"\",\n \"account_external\": {\n \"account_type_id\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"external_account_details\": \"\",\n \"external_account_details_encrypted\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\",\n \"account_details\": \"\",\n \"account_details_encrypted\": \"\"\n },\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_email\": \"\",\n \"user_external_id\": \"\",\n \"legal_entity_id\": \"\",\n \"phone\": \"\",\n \"payout_currency\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"batch_id\": \"\",\n \"cuscal_payment_transaction_id\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"from_user_name\": \"\",\n \"from_user_id\": \"\",\n \"refund_state\": \"\",\n \"currency\": \"\",\n \"company\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_postcode\": \"\",\n \"address_country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"three_code\": \"\",\n \"two_code\": \"\",\n \"currency_id\": \"\",\n \"numeric_code\": \"\"\n },\n \"country\": \"\",\n \"debit_credit\": \"\",\n \"description\": \"\",\n \"item\": {\n \"id\": \"\",\n \"item_number\": \"\"\n },\n \"deposit_reference\": \"\",\n \"related\": {\n \"account_to\": {\n \"id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"fees\": \"\",\n \"wallet_accounts\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"items\": \"\",\n \"marketplace\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-f1795935-894d-4ef6-8f4c-78fe84396be4" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ab27d234-2e7d-45ff-a9a2-42e75816e799" } ], "id": "9007b07c-31e1-460d-93aa-f12c177b4562", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9007b07c-31e1-460d-93aa-f12c177b4562" }, { "name": "List Batch Transactions", "id": "8e464bab-3a38-4ef2-99bc-965a8a979c99", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/batch_transactions?limit=10&offset=0&account_id=&batch_id=&item_id=&transaction_type=payment&transaction_type_method=misc&direction=debit&created_before=&created_after=&disbursement_bank=&processing_bank=", "host": [ "{{baseUrl}}" ], "path": [ "batch_transactions" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Bank, Card or Wallet Account ID.", "key": "account_id", "value": "" }, { "description": "Batch ID. This appears on a bank reference.", "key": "batch_id", "value": "" }, { "description": "Item ID", "key": "item_id", "value": "" }, { "description": "The type of transaction. Options for querying are: payment, refund, disbursement, fee, deposit, withdrawal. For returned values please refer here: [Enumeration Values](https://developer.assemblypayments.com/docs/enumeration-values) for the full list", "key": "transaction_type", "value": "payment" }, { "description": "The method the transaction was carried out with. Options for querying are: credit_card, npp, bpay, wire_transfer, wallet_account_transfer, misc. For returned values please refer here: [Enumeration Values](https://developer.assemblypayments.com/docs/enumeration-values) for the full list", "key": "transaction_type_method", "value": "misc" }, { "description": "Direction of the transaction. Options are debit, credit", "key": "direction", "value": "debit" }, { "description": "Date and time in ISO 8601 format the item(s) were created before (e.g. 2020-02-27T23:54:59Z)", "key": "created_before", "value": "" }, { "description": "Date and time in ISO 8601 format the item(s) were created after (e.g. 2020-02-27T23:54:59Z)", "key": "created_after", "value": "" }, { "description": "The bank used for disbursing the payment. Please use a default value of `any`", "key": "disbursement_bank", "value": "" }, { "description": "The bank used for processing the payment. Please use a default value of `any`", "key": "processing_bank", "value": "" } ] }, "description": "Retrieve an ordered and paginated list of existing **Batch Transactions**. The list can be filtered by **Account**, **Batch ID**, **Item**, and **Transaction Type**.\n" }, "response": [ { "id": "e094b518-7391-4683-8fc1-82e0190f3bd8", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/batch_transactions?limit=10&offset=0&account_id=&batch_id=&item_id=&transaction_type=payment&transaction_type_method=misc&direction=debit&created_before=&created_after=&disbursement_bank=&processing_bank=", "host": [ "{{baseUrl}}" ], "path": [ "batch_transactions" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Bank, Card or Wallet Account ID.", "key": "account_id", "value": "" }, { "description": "Batch ID. This appears on a bank reference.", "key": "batch_id", "value": "" }, { "description": "Item ID", "key": "item_id", "value": "" }, { "description": "The type of transaction. Options for querying are: payment, refund, disbursement, fee, deposit, withdrawal. For returned values please refer here: [Enumeration Values](https://developer.assemblypayments.com/docs/enumeration-values) for the full list", "key": "transaction_type", "value": "payment" }, { "description": "The method the transaction was carried out with. Options for querying are: credit_card, npp, bpay, wire_transfer, wallet_account_transfer, misc. For returned values please refer here: [Enumeration Values](https://developer.assemblypayments.com/docs/enumeration-values) for the full list", "key": "transaction_type_method", "value": "misc" }, { "description": "Direction of the transaction. Options are debit, credit", "key": "direction", "value": "debit" }, { "description": "Date and time in ISO 8601 format the item(s) were created before (e.g. 2020-02-27T23:54:59Z)", "key": "created_before", "value": "" }, { "description": "Date and time in ISO 8601 format the item(s) were created after (e.g. 2020-02-27T23:54:59Z)", "key": "created_after", "value": "" }, { "description": "The bank used for disbursing the payment. Please use a default value of `any`", "key": "disbursement_bank", "value": "" }, { "description": "The bank used for processing the payment. Please use a default value of `any`", "key": "processing_bank", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"batch_transactions\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"status\": \"\",\n \"uuid\": \"\",\n \"disbursement_bank\": \"\",\n \"processing_bank\": \"\",\n \"external_reference\": \"\",\n \"reference_amount\": \"\",\n \"internal_state\": \"\",\n \"internal_status\": \"\",\n \"account_external\": {\n \"account_type_id\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"external_account_details\": \"\",\n \"external_account_details_encrypted\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\",\n \"account_details\": \"\",\n \"account_details_encrypted\": \"\"\n },\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_email\": \"\",\n \"user_external_id\": \"\",\n \"legal_entity_id\": \"\",\n \"phone\": \"\",\n \"payout_currency\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"batch_id\": \"\",\n \"cuscal_payment_transaction_id\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"from_user_name\": \"\",\n \"from_user_id\": \"\",\n \"refund_state\": \"\",\n \"currency\": \"\",\n \"company\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_postcode\": \"\",\n \"address_country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"three_code\": \"\",\n \"two_code\": \"\",\n \"currency_id\": \"\",\n \"numeric_code\": \"\"\n },\n \"country\": \"\",\n \"debit_credit\": \"\",\n \"description\": \"\",\n \"item\": {\n \"id\": \"\",\n \"item_number\": \"\"\n },\n \"deposit_reference\": \"\",\n \"related\": {\n \"account_to\": {\n \"id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"fees\": \"\",\n \"wallet_accounts\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"items\": \"\",\n \"marketplace\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"status\": \"\",\n \"uuid\": \"\",\n \"disbursement_bank\": \"\",\n \"processing_bank\": \"\",\n \"external_reference\": \"\",\n \"reference_amount\": \"\",\n \"internal_state\": \"\",\n \"internal_status\": \"\",\n \"account_external\": {\n \"account_type_id\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"external_account_details\": \"\",\n \"external_account_details_encrypted\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\",\n \"account_details\": \"\",\n \"account_details_encrypted\": \"\"\n },\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_email\": \"\",\n \"user_external_id\": \"\",\n \"legal_entity_id\": \"\",\n \"phone\": \"\",\n \"payout_currency\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"batch_id\": \"\",\n \"cuscal_payment_transaction_id\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"from_user_name\": \"\",\n \"from_user_id\": \"\",\n \"refund_state\": \"\",\n \"currency\": \"\",\n \"company\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_postcode\": \"\",\n \"address_country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"three_code\": \"\",\n \"two_code\": \"\",\n \"currency_id\": \"\",\n \"numeric_code\": \"\"\n },\n \"country\": \"\",\n \"debit_credit\": \"\",\n \"description\": \"\",\n \"item\": {\n \"id\": \"\",\n \"item_number\": \"\"\n },\n \"deposit_reference\": \"\",\n \"related\": {\n \"account_to\": {\n \"id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"fees\": \"\",\n \"wallet_accounts\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"items\": \"\",\n \"marketplace\": \"\"\n }\n }\n ],\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-e094b518-7391-4683-8fc1-82e0190f3bd8" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-8e464bab-3a38-4ef2-99bc-965a8a979c99" } ], "id": "a42b4d1b-6b31-4b51-bd57-c8470a3ebf4e", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a42b4d1b-6b31-4b51-bd57-c8470a3ebf4e" }, { "name": "disbursements", "item": [ { "name": "{id}", "item": [ { "name": "transactions", "item": [ { "name": "Show Disbursement Transactions", "id": "ceab0cdb-22e8-4efe-97f4-6dbbd55b1a5c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disbursements/:id/transactions?limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "disbursements", ":id", "transactions" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" } ], "variable": [ { "id": "57863484-e5c8-4609-b49d-c07e79c38012", "key": "id", "value": "90c1418b-f4f4-413e-a4ba-f29c334e7f55", "description": "(Required) Disbursement ID" } ] }, "description": "Get all the transactions relating to a disbursment ID" }, "response": [ { "id": "a936d509-5c59-4840-9d1b-e81b2d7b1ae7", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/disbursements/:id/transactions?limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "disbursements", ":id", "transactions" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"payee_name\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\",\n \"dynamic_descriptor\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"debit_credit\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\"\n },\n \"related\": {\n \"transactions\": [\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n }\n ]\n },\n \"payee_details\": {\n \"debtor_name\": \"\",\n \"debtor_legal_name\": \"\",\n \"debtor_bsb\": \"\",\n \"debtor_account\": \"\",\n \"clearing_system_transaction_id\": \"\",\n \"remittance_information\": \"\",\n \"pay_id\": \"\",\n \"pay_id_type\": \"\",\n \"end_to_end_id\": \"\",\n \"npp_payin_internal_id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"fees\": \"\",\n \"wallet_accounts\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"items\": \"\",\n \"marketplaces\": \"\",\n \"npp_payin_transaction_detail\": \"\",\n \"supplementary_data\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"payee_name\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\",\n \"dynamic_descriptor\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"debit_credit\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\"\n },\n \"related\": {\n \"transactions\": [\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n }\n ]\n },\n \"payee_details\": {\n \"debtor_name\": \"\",\n \"debtor_legal_name\": \"\",\n \"debtor_bsb\": \"\",\n \"debtor_account\": \"\",\n \"clearing_system_transaction_id\": \"\",\n \"remittance_information\": \"\",\n \"pay_id\": \"\",\n \"pay_id_type\": \"\",\n \"end_to_end_id\": \"\",\n \"npp_payin_internal_id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"fees\": \"\",\n \"wallet_accounts\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"items\": \"\",\n \"marketplaces\": \"\",\n \"npp_payin_transaction_detail\": \"\",\n \"supplementary_data\": \"\"\n }\n }\n ],\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a936d509-5c59-4840-9d1b-e81b2d7b1ae7" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ceab0cdb-22e8-4efe-97f4-6dbbd55b1a5c" } ], "id": "2a7c79dd-11ef-4b69-aefb-be4215a27e01", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2a7c79dd-11ef-4b69-aefb-be4215a27e01" }, { "name": "wallet_accounts", "item": [ { "name": "Show Disbursement Wallet Accounts", "id": "518bd59d-6df8-4374-8d2e-0fb02c3da5fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disbursements/:id/wallet_accounts", "host": [ "{{baseUrl}}" ], "path": [ "disbursements", ":id", "wallet_accounts" ], "variable": [ { "id": "8ac43917-56c9-4794-a494-ee7578170cc7", "key": "id", "value": "90c1418b-f4f4-413e-a4ba-f29c334e7f55", "description": "(Required) Disbursement ID" } ] }, "description": "Get all the wallet accounts relating to a disbursment ID" }, "response": [ { "id": "b6852048-80dd-420f-b2fe-3b32270a82cb", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/disbursements/:id/wallet_accounts", "host": [ "{{baseUrl}}" ], "path": [ "disbursements", ":id", "wallet_accounts" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"wallet_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"not_verified\",\n \"balance\": \"\",\n \"links\": {\n \"self\": {},\n \"users\": {},\n \"batch_transactions\": {},\n \"transactions\": {},\n \"bpay_details\": {},\n \"npp_details\": {},\n \"virtual_accounts\": {}\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b6852048-80dd-420f-b2fe-3b32270a82cb" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-518bd59d-6df8-4374-8d2e-0fb02c3da5fd" } ], "id": "40dc791c-c9d8-4aa9-853c-be2eb9aa50cb", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-40dc791c-c9d8-4aa9-853c-be2eb9aa50cb" }, { "name": "bank_accounts", "item": [ { "name": "Show Disbursement Bank Accounts", "id": "89818a92-1582-47e8-bd3f-bab0e703d716", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disbursements/:id/bank_accounts", "host": [ "{{baseUrl}}" ], "path": [ "disbursements", ":id", "bank_accounts" ], "variable": [ { "id": "97edee5f-92d8-47c0-aa3a-a9bdf68444b1", "key": "id", "value": "90c1418b-f4f4-413e-a4ba-f29c334e7f55", "description": "(Required) Disbursement ID" } ] }, "description": "Get all the bank accounts relating to disbursement ID" }, "response": [ { "id": "d232ab65-324b-4335-a57d-81181966da44", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/disbursements/:id/bank_accounts", "host": [ "{{baseUrl}}" ], "path": [ "disbursements", ":id", "bank_accounts" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"bank_accounts\": {\n \"active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"id\": \"\",\n \"currency\": \"\",\n \"verification_status\": \"not_verified\",\n \"verification\": {\n \"verified_at\": \"\",\n \"verification_method\": \"COP\",\n \"result\": {\n \"match_result\": \"NMTO\"\n }\n },\n \"bank\": {\n \"bank_name\": \"\",\n \"country\": \"\",\n \"account_name\": \"\",\n \"routing_number\": \"\",\n \"account_number\": \"\",\n \"holder_type\": \"business\",\n \"account_type\": \"savings\",\n \"direct_debit_authority_status\": \"null\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"direct_debit_authorities\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d232ab65-324b-4335-a57d-81181966da44" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-89818a92-1582-47e8-bd3f-bab0e703d716" } ], "id": "eea73a19-f190-4b72-b3b5-1f5bfc783566", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-eea73a19-f190-4b72-b3b5-1f5bfc783566" }, { "name": "users", "item": [ { "name": "Show Disbursement Users", "id": "a509d4f8-e48b-48b1-91bd-c10150c36402", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disbursements/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "disbursements", ":id", "users" ], "variable": [ { "id": "6b769933-4560-432a-aef3-108eb3ba0eb2", "key": "id", "value": "90c1418b-f4f4-413e-a4ba-f29c334e7f55", "description": "(Required) Disbursement ID" } ] }, "description": "Get all the users relating to disbursement ID" }, "response": [ { "id": "027a0849-95cc-4fa4-9949-a963ac60029f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/disbursements/:id/users", "host": [ "{{baseUrl}}" ], "path": [ "disbursements", ":id", "users" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-027a0849-95cc-4fa4-9949-a963ac60029f" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a509d4f8-e48b-48b1-91bd-c10150c36402" } ], "id": "a4987838-be7c-48e0-9cf3-7d3604ecd319", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a4987838-be7c-48e0-9cf3-7d3604ecd319" }, { "name": "items", "item": [ { "name": "Show Disbursement Items", "id": "a32146a1-6b06-4bb4-bace-c8fc986d19a9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disbursements/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "disbursements", ":id", "items" ], "variable": [ { "id": "52c90bca-dc74-4982-ba94-cb6f65ff4bb9", "key": "id", "value": "90c1418b-f4f4-413e-a4ba-f29c334e7f55", "description": "(Required) Disbursement ID" } ] }, "description": "Get all the items relating to a disbursement ID" }, "response": [ { "id": "c22305c4-8f67-459c-b213-90b294a3e85f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/disbursements/:id/items", "host": [ "{{baseUrl}}" ], "path": [ "disbursements", ":id", "items" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"payment_held\",\n \"status\": 22400,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"partial_paid\",\n \"status\": 22500,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n ],\n \"links\": {\n \"self\": \"\"\n },\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-c22305c4-8f67-459c-b213-90b294a3e85f" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a32146a1-6b06-4bb4-bace-c8fc986d19a9" } ], "id": "1e274cac-4be1-4494-9903-b7eb211e7c64", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-1e274cac-4be1-4494-9903-b7eb211e7c64" }, { "name": "Show Disbursement", "id": "4721e874-251a-4545-a7d8-4482fda56e3d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disbursements/:id", "host": [ "{{baseUrl}}" ], "path": [ "disbursements", ":id" ], "variable": [ { "id": "b85482a5-71c6-40cf-9d93-593fdf07cecb", "key": "id", "value": "90c1418b-f4f4-413e-a4ba-f29c334e7f55", "description": "(Required) Disbursement ID" } ] }, "description": "Get a disbursment using its ID" }, "response": [ { "id": "c5a54c8f-d567-41fe-88eb-4b46e0905316", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/disbursements/:id", "host": [ "{{baseUrl}}" ], "path": [ "disbursements", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"disbursements\": {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"batch_id\": \"\",\n \"cuscal_payment_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"\",\n \"to\": \"\",\n \"bank_name\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"npp_payout_state\": \"\",\n \"account_name\": \"\",\n \"biller_name\": \"\",\n \"biller_code\": \"\",\n \"crn\": \"\",\n \"links\": {\n \"transactions\": \"\",\n \"wallet_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"items\": \"\",\n \"users\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-c5a54c8f-d567-41fe-88eb-4b46e0905316" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4721e874-251a-4545-a7d8-4482fda56e3d" } ], "id": "1f8d3c05-fa22-4df1-b545-a7742e1be741", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-1f8d3c05-fa22-4df1-b545-a7742e1be741" }, { "name": "List Disbursements", "id": "9da3c603-a19b-40f9-8246-f3cd2a0acd63", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/disbursements?limit=10&offset=0&batch_id=", "host": [ "{{baseUrl}}" ], "path": [ "disbursements" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Batch ID.", "key": "batch_id", "value": "" } ] }, "description": "Retrieve an ordered and paginated list of existing **Disbursements**. The list can be filtered by **Batch ID**.\n" }, "response": [ { "id": "17e1ebcb-30eb-486e-a2dc-71410ef8ffcc", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/disbursements?limit=10&offset=0&batch_id=", "host": [ "{{baseUrl}}" ], "path": [ "disbursements" ], "query": [ { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Batch ID.", "key": "batch_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"disbursements\": [\n {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"batch_id\": \"\",\n \"cuscal_payment_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"\",\n \"to\": \"\",\n \"bank_name\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"npp_payout_state\": \"\",\n \"account_name\": \"\",\n \"biller_name\": \"\",\n \"biller_code\": \"\",\n \"crn\": \"\",\n \"links\": {\n \"transactions\": \"\",\n \"wallet_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"items\": \"\",\n \"users\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"batch_id\": \"\",\n \"cuscal_payment_transaction_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"\",\n \"to\": \"\",\n \"bank_name\": \"\",\n \"bank_account_name\": \"\",\n \"bank_account_number\": \"\",\n \"bank_routing_number\": \"\",\n \"npp_payout_state\": \"\",\n \"account_name\": \"\",\n \"biller_name\": \"\",\n \"biller_code\": \"\",\n \"crn\": \"\",\n \"links\": {\n \"transactions\": \"\",\n \"wallet_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"items\": \"\",\n \"users\": \"\"\n }\n }\n ],\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-17e1ebcb-30eb-486e-a2dc-71410ef8ffcc" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9da3c603-a19b-40f9-8246-f3cd2a0acd63" } ], "id": "63f44d38-a686-463d-a4c4-1f92a6c487e8", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-63f44d38-a686-463d-a4c4-1f92a6c487e8" }, { "name": "items", "item": [ { "name": "{id}", "item": [ { "name": "sellers", "item": [ { "name": "Show Item Seller", "id": "946e9498-43d7-4726-ba94-3de46da0dcfe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/sellers", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "sellers" ], "variable": [ { "id": "a86869ed-2d6a-4e52-8dc4-1370cad52fe3", "key": "id", "value": "7190973-1-3780", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Show the seller **User** associated with the **Item** using a given `:id`." }, "response": [ { "id": "d37293bd-85bf-4279-83b9-ed6468fea35e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id/sellers", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "sellers" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d37293bd-85bf-4279-83b9-ed6468fea35e" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-946e9498-43d7-4726-ba94-3de46da0dcfe" } ], "id": "d62cbd5f-8a25-4875-9420-454fc3986f00", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d62cbd5f-8a25-4875-9420-454fc3986f00" }, { "name": "buyers", "item": [ { "name": "Show Item Buyer", "id": "0374566b-680c-4ea7-9776-18b79744e348", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/buyers", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "buyers" ], "variable": [ { "id": "2372b9e9-2625-49c9-b0f6-de572a068a5f", "key": "id", "value": "7190973-1-3780", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Show the buyer **User** associated with the **Item** using a given `:id`." }, "response": [ { "id": "88cffdc6-a3af-4175-9649-48367b96a48c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id/buyers", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "buyers" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"users\": {\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"full_name\": \"\",\n \"email\": \"\",\n \"mobile\": \"\",\n \"phone\": \"\",\n \"logo_url\": \"\",\n \"color_1\": \"\",\n \"color_2\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"id\": \"\",\n \"custom_descriptor\": \"\",\n \"location\": \"\",\n \"verification_status\": \"\",\n \"held_state\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ],\n \"dob\": \"\",\n \"government_number\": \"\",\n \"drivers_license\": \"\",\n \"flags\": {},\n \"related\": {\n \"addresses\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"items\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"payid_accounts\": \"\",\n \"bpay_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"wallet_accounts\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-88cffdc6-a3af-4175-9649-48367b96a48c" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-0374566b-680c-4ea7-9776-18b79744e348" } ], "id": "72154755-f996-4f46-ab69-a5df1ffbda88", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-72154755-f996-4f46-ab69-a5df1ffbda88" }, { "name": "fees", "item": [ { "name": "Show Item Fees", "id": "68736e5c-bacf-41c4-b87d-d93baec6eec5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/fees", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "fees" ], "variable": [ { "id": "918512d0-03f3-49b7-be09-ebaa083e6322", "key": "id", "value": "7190973-1-3780", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Show the **Fees** associated with the **Item** using a given `:id`." }, "response": [ { "id": "1120e711-8bc8-4dba-adb7-167755c59268", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id/fees", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "fees" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"fees\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"name\": \"\",\n \"fee_type_id\": \"\",\n \"amount\": \"\",\n \"cap\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"to\": \"\",\n \"calculated_fee\": \"\",\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"name\": \"\",\n \"fee_type_id\": \"\",\n \"amount\": \"\",\n \"cap\": \"\",\n \"min\": \"\",\n \"max\": \"\",\n \"to\": \"\",\n \"calculated_fee\": \"\",\n \"links\": {\n \"self\": \"\"\n }\n }\n ],\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-1120e711-8bc8-4dba-adb7-167755c59268" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-68736e5c-bacf-41c4-b87d-d93baec6eec5" } ], "id": "b607849c-9c05-4235-94b3-8f0ac088815e", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b607849c-9c05-4235-94b3-8f0ac088815e" }, { "name": "wire_details", "item": [ { "name": "Show Item Wire Details", "id": "3e03d4a6-082d-42c3-ba77-39f907ad1f60", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/wire_details", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "wire_details" ], "variable": [ { "id": "1c767de3-3ae9-4a74-919b-66a32f43b4f7", "key": "id", "value": "7190985-1-9382", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Show the **Item** wire payment details using a given `:id`." }, "response": [ { "id": "2b566e14-01ec-42f4-97e6-8c2f8de4e179", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id/wire_details", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "wire_details" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"wire_details\": {\n \"beneficiary\": \"\",\n \"address_line1\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"routing_number\": \"\",\n \"account_number\": \"\",\n \"bank_name\": \"\",\n \"swift\": \"\",\n \"reference\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"country\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2b566e14-01ec-42f4-97e6-8c2f8de4e179" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-3e03d4a6-082d-42c3-ba77-39f907ad1f60" } ], "id": "d147f19a-719f-478d-bd36-e9bd6c1de66f", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d147f19a-719f-478d-bd36-e9bd6c1de66f" }, { "name": "transactions", "item": [ { "name": "List Item Transactions", "id": "2d450591-5d26-4351-a8c7-99b0822b8003", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/transactions", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "transactions" ], "variable": [ { "id": "66efb8af-7ddd-4171-a572-b1f55e37d93b", "key": "id", "value": "7190985-1-9382", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Retrieve an ordered and paginated list of **Transactions** associated with the **Item** using a given `:id`." }, "response": [ { "id": "ae6d5ad3-1d86-4db7-88bb-c85ff154dd7a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id/transactions", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "transactions" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"transactions\": [\n {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"payee_name\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\",\n \"dynamic_descriptor\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"debit_credit\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\"\n },\n \"related\": {\n \"transactions\": [\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n }\n ]\n },\n \"payee_details\": {\n \"debtor_name\": \"\",\n \"debtor_legal_name\": \"\",\n \"debtor_bsb\": \"\",\n \"debtor_account\": \"\",\n \"clearing_system_transaction_id\": \"\",\n \"remittance_information\": \"\",\n \"pay_id\": \"\",\n \"pay_id_type\": \"\",\n \"end_to_end_id\": \"\",\n \"npp_payin_internal_id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"fees\": \"\",\n \"wallet_accounts\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"items\": \"\",\n \"marketplaces\": \"\",\n \"npp_payin_transaction_detail\": \"\",\n \"supplementary_data\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"reference_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"payee_name\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\",\n \"dynamic_descriptor\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"debit_credit\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\"\n },\n \"related\": {\n \"transactions\": [\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n },\n {\n \"id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\",\n \"item_name\": \"\"\n }\n ]\n },\n \"payee_details\": {\n \"debtor_name\": \"\",\n \"debtor_legal_name\": \"\",\n \"debtor_bsb\": \"\",\n \"debtor_account\": \"\",\n \"clearing_system_transaction_id\": \"\",\n \"remittance_information\": \"\",\n \"pay_id\": \"\",\n \"pay_id_type\": \"\",\n \"end_to_end_id\": \"\",\n \"npp_payin_internal_id\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"fees\": \"\",\n \"wallet_accounts\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"items\": \"\",\n \"marketplaces\": \"\",\n \"npp_payin_transaction_detail\": \"\",\n \"supplementary_data\": \"\"\n }\n }\n ],\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ae6d5ad3-1d86-4db7-88bb-c85ff154dd7a" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2d450591-5d26-4351-a8c7-99b0822b8003" } ], "id": "a4080972-f8a6-488e-bbec-8579709058b6", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a4080972-f8a6-488e-bbec-8579709058b6" }, { "name": "batch_transactions", "item": [ { "name": "List Item Batch Transactions", "id": "c8b3129e-6a3f-463c-b923-6b79c554042c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/batch_transactions", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "batch_transactions" ], "variable": [ { "id": "8fab2faa-e34b-43d8-8a87-17d739640667", "key": "id", "value": "7139651-1-2046", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Retrieve an ordered and paginated list of **Batch Transactions** associated with the `Item` using a given `:id`. This will include both direct debits coming in, and the disbursements going out." }, "response": [ { "id": "4f51c7a7-7a4b-475c-a887-201b2e80746f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id/batch_transactions", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "batch_transactions" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"batch_transactions\": [\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"status\": \"\",\n \"uuid\": \"\",\n \"disbursement_bank\": \"\",\n \"processing_bank\": \"\",\n \"external_reference\": \"\",\n \"reference_amount\": \"\",\n \"internal_state\": \"\",\n \"internal_status\": \"\",\n \"account_external\": {\n \"account_type_id\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"external_account_details\": \"\",\n \"external_account_details_encrypted\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\",\n \"account_details\": \"\",\n \"account_details_encrypted\": \"\"\n },\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_email\": \"\",\n \"user_external_id\": \"\",\n \"legal_entity_id\": \"\",\n \"phone\": \"\",\n \"payout_currency\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"batch_id\": \"\",\n \"cuscal_payment_transaction_id\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"from_user_name\": \"\",\n \"from_user_id\": \"\",\n \"refund_state\": \"\",\n \"currency\": \"\",\n \"company\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_postcode\": \"\",\n \"address_country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"three_code\": \"\",\n \"two_code\": \"\",\n \"currency_id\": \"\",\n \"numeric_code\": \"\"\n },\n \"country\": \"\",\n \"debit_credit\": \"\",\n \"description\": \"\",\n \"item\": {\n \"id\": \"\",\n \"item_number\": \"\"\n },\n \"deposit_reference\": \"\",\n \"related\": {\n \"account_to\": {\n \"id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"fees\": \"\",\n \"wallet_accounts\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"items\": \"\",\n \"marketplace\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"amount\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference_id\": \"\",\n \"status\": \"\",\n \"uuid\": \"\",\n \"disbursement_bank\": \"\",\n \"processing_bank\": \"\",\n \"external_reference\": \"\",\n \"reference_amount\": \"\",\n \"internal_state\": \"\",\n \"internal_status\": \"\",\n \"account_external\": {\n \"account_type_id\": \"\",\n \"currency\": {\n \"code\": \"\"\n }\n },\n \"external_account_details\": \"\",\n \"external_account_details_encrypted\": \"\",\n \"marketplace\": {\n \"group_name\": \"\",\n \"name\": \"\",\n \"short_name\": \"\",\n \"uuid\": \"\",\n \"account_details\": \"\",\n \"account_details_encrypted\": \"\"\n },\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"user_email\": \"\",\n \"user_external_id\": \"\",\n \"legal_entity_id\": \"\",\n \"phone\": \"\",\n \"payout_currency\": \"\",\n \"type\": \"\",\n \"type_method\": \"\",\n \"batch_id\": \"\",\n \"cuscal_payment_transaction_id\": \"\",\n \"reference\": \"\",\n \"state\": \"\",\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"account_type\": \"\",\n \"from_user_name\": \"\",\n \"from_user_id\": \"\",\n \"refund_state\": \"\",\n \"currency\": \"\",\n \"company\": \"\",\n \"address_line1\": \"\",\n \"address_line2\": \"\",\n \"address_city\": \"\",\n \"address_state\": \"\",\n \"address_postcode\": \"\",\n \"address_country\": {\n \"id\": \"\",\n \"name\": \"\",\n \"three_code\": \"\",\n \"two_code\": \"\",\n \"currency_id\": \"\",\n \"numeric_code\": \"\"\n },\n \"country\": \"\",\n \"debit_credit\": \"\",\n \"description\": \"\",\n \"item\": {\n \"id\": \"\",\n \"item_number\": \"\"\n },\n \"deposit_reference\": \"\",\n \"related\": {\n \"account_to\": {\n \"id\": \"\",\n \"account_type\": \"\",\n \"user_id\": \"\"\n }\n },\n \"links\": {\n \"self\": \"\",\n \"users\": \"\",\n \"fees\": \"\",\n \"wallet_accounts\": \"\",\n \"card_accounts\": \"\",\n \"paypal_accounts\": \"\",\n \"bank_accounts\": \"\",\n \"items\": \"\",\n \"marketplace\": \"\"\n }\n }\n ],\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n },\n \"links\": {\n \"self\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-4f51c7a7-7a4b-475c-a887-201b2e80746f" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-c8b3129e-6a3f-463c-b923-6b79c554042c" } ], "id": "a7870c75-7c2b-4877-a3a0-644b40d65e3b", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a7870c75-7c2b-4877-a3a0-644b40d65e3b" }, { "name": "status", "item": [ { "name": "Show Item Status", "id": "ad0d2031-65a3-4f53-9522-01e0e1249a03", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "status" ], "variable": [ { "id": "5e95aa18-7c84-4545-bb45-e252ee047009", "key": "id", "value": "7139651-1-2046", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Show the status of an **Item** using a given `:id`." }, "response": [ { "id": "6f1b725b-aa1f-402e-a8b0-91025fe26cb8", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id/status", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "status" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"status\": \"\",\n \"state\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-6f1b725b-aa1f-402e-a8b0-91025fe26cb8" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ad0d2031-65a3-4f53-9522-01e0e1249a03" } ], "id": "c850b18d-71d3-43f5-a16c-fb8749564ce0", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-c850b18d-71d3-43f5-a16c-fb8749564ce0" }, { "name": "make_payment", "item": [ { "name": "Make Payment", "id": "5d7292d7-023b-4140-94c7-a622bc21fcff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"725cc8c0-759b-0138-5d6d-0a58a9feac05\",\n \"device_id\": \"\",\n \"ip_address\": \"\",\n \"cvv\": \"\",\n \"merchant_phone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id/make_payment", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "make_payment" ], "variable": [ { "id": "4ffa333c-f975-497d-b3d3-c0bcb9554503", "key": "id", "value": "7190770-1-2908", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Make a payment for an **Item**. Pass the `:account_id` of a **Bank Account** or a **Card Account** associated with the **Item's** buyer. The **Item** state will transition to one of `payment_held`, `payment_pending` or `completed` for an **Express** or **Approve** payment type.\n" }, "response": [ { "id": "d36ee89e-063e-450b-928b-4018a21db250", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"725cc8c0-759b-0138-5d6d-0a58a9feac05\",\n \"device_id\": \"\",\n \"ip_address\": \"\",\n \"cvv\": \"\",\n \"merchant_phone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id/make_payment", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "make_payment" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"completed\",\n \"status\": 22190,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d36ee89e-063e-450b-928b-4018a21db250" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-5d7292d7-023b-4140-94c7-a622bc21fcff" } ], "id": "43f9640e-d1f2-448b-a9d1-157929ed8c90", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-43f9640e-d1f2-448b-a9d1-157929ed8c90" }, { "name": "make_payment_async", "item": [ { "name": "Make an async Payment", "id": "3e432863-82e0-4ca0-9611-905f9ab4a92d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"\",\n \"request_three_d_secure\": \"automatic\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id/make_payment_async", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "make_payment_async" ], "variable": [ { "id": "2428905c-9c0a-4c8e-abd4-cbe995d5fbdd", "key": "id", "value": "", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Initiate a card payment with 3D Secure 2.0 authentication support.\nThis endpoint initiates the payment process and returns a `payment_token`\nrequired for 3DS2 component initialisation.\n" }, "response": [ { "id": "2970c75b-0db6-4210-91ee-a46b6932bed8", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"\",\n \"request_three_d_secure\": \"automatic\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id/make_payment_async", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "make_payment_async" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_id\": \"\",\n \"account_id\": \"\",\n \"payment_token\": \"\",\n \"items\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"off_platform_refunded\",\n \"status\": 22800,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-2970c75b-0db6-4210-91ee-a46b6932bed8" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-3e432863-82e0-4ca0-9611-905f9ab4a92d" } ], "id": "eed18927-2203-4c02-a395-c9c6e7044ab8", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-eed18927-2203-4c02-a395-c9c6e7044ab8" }, { "name": "cancel", "item": [ { "name": "Cancel", "id": "a2ce6124-bc23-4d23-851c-bc7472600016", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "cancel" ], "variable": [ { "id": "b0c43f07-d5db-4356-a7ab-7825cd861cb9", "key": "id", "value": "7190770-1-2908", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Cancel an **Item**. This will transition the **Item** state to `cancelled`. **Items** can only be cancelled if they haven't been actioned in any other way." }, "response": [ { "id": "30281742-9044-4e1c-93b6-36db0b729640", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "cancel" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"completed\",\n \"status\": 22190,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-30281742-9044-4e1c-93b6-36db0b729640" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a2ce6124-bc23-4d23-851c-bc7472600016" } ], "id": "425d9ea9-4138-4da2-a764-751ac25d81ec", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-425d9ea9-4138-4da2-a764-751ac25d81ec" }, { "name": "refund", "item": [ { "name": "Refund", "id": "44ba59aa-0f87-4e76-9fa7-1070282833b7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"refund_amount\": \"\",\n \"refund_message\": \"\",\n \"account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id/refund", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "refund" ], "variable": [ { "id": "110446f0-9c2c-44ab-b2ee-2e7247c362ee", "key": "id", "value": "7190770-1-2908", "description": "(Required) Marketplace / Platform item ID to be refunded" } ] }, "description": "Refund an **Item**'s funds. A partial `amount` can be specified otherwise the full amount will be refunded. This will transition the **Item** state to 'refunded' if the full amount is refunded, or to the previously held state if a partial `amount` is specified." }, "response": [ { "id": "534bbd41-bc77-4cfb-98d3-940f5c594a94", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"refund_amount\": \"\",\n \"refund_message\": \"\",\n \"account_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id/refund", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "refund" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"completed\",\n \"status\": 22190,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-534bbd41-bc77-4cfb-98d3-940f5c594a94" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-44ba59aa-0f87-4e76-9fa7-1070282833b7" } ], "id": "90956f4a-bc29-4909-bd35-b41a75449825", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-90956f4a-bc29-4909-bd35-b41a75449825" }, { "name": "authorize_payment", "item": [ { "name": "Authorize Payment", "id": "e53e2818-f3ea-492f-89f4-710e7395ae62", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"725cc8c0-759b-0138-5d6d-0a58a9feac05\",\n \"cvv\": \"\",\n \"merchant_phone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id/authorize_payment", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "authorize_payment" ], "variable": [ { "id": "2c02dd95-c28e-44cf-a615-687c3e0fb1f6", "key": "id", "value": "7190770-1-2908", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Where pre-authentication is enabled on a platform, initiates a credit card payment authorization for an item. When an authorization is successful, your platform holds the item amount for capture, but there is no transfer of funds happening. This call is used with the Capture Payment or Void Payment calls.\n" }, "response": [ { "id": "6345cfef-ab6a-460a-82a9-cf2d6e5ab17a", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"account_id\": \"725cc8c0-759b-0138-5d6d-0a58a9feac05\",\n \"cvv\": \"\",\n \"merchant_phone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id/authorize_payment", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "authorize_payment" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"completed\",\n \"status\": 22190,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-6345cfef-ab6a-460a-82a9-cf2d6e5ab17a" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-e53e2818-f3ea-492f-89f4-710e7395ae62" } ], "id": "11006119-32a9-42bd-9313-5da5f64a7bcd", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-11006119-32a9-42bd-9313-5da5f64a7bcd" }, { "name": "capture_payment", "item": [ { "name": "Capture Payment", "id": "9c545733-d883-4bbd-81a2-a83dd31a5b39", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id/capture_payment", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "capture_payment" ], "variable": [ { "id": "720824f7-7f8d-4a2c-860d-8c4efd9c2624", "key": "id", "value": "7190770-1-2908", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Where pre-authentication is enabled on a platform, completes a credit card payment for an item whose payment is authorized. This call is used with the Authorize Payment call.\n" }, "response": [ { "id": "75ebc230-52d2-45fd-bc25-2486cc031a4b", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id/capture_payment", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "capture_payment" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"completed\",\n \"status\": 22190,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-75ebc230-52d2-45fd-bc25-2486cc031a4b" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-9c545733-d883-4bbd-81a2-a83dd31a5b39" } ], "id": "40b9394a-88fe-451d-a172-b0eea7c64984", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-40b9394a-88fe-451d-a172-b0eea7c64984" }, { "name": "void_payment", "item": [ { "name": "Void Payment", "id": "dad5aca2-1d24-4a1a-a26a-30b69348b4ef", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id/void_payment", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "void_payment" ], "variable": [ { "id": "16474e40-136d-4bc6-be74-64d4beec3304", "key": "id", "value": "7190770-1-2908", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Where pre-authentication is enabled on a platform, voids the `payment_authorized` status for an item. This call is used with the Authorize Payment call. **Note**: Not all payment gateways support the Void Payment API call. In this case, you can wait until a payment authorization expires. A payment authorisation expires after 3 to 6 days if not captured.\n" }, "response": [ { "id": "77580748-f1a0-4f30-bd59-51ef9286fa3a", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id/void_payment", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "void_payment" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"completed\",\n \"status\": 22190,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-77580748-f1a0-4f30-bd59-51ef9286fa3a" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-dad5aca2-1d24-4a1a-a26a-30b69348b4ef" } ], "id": "14c9674e-36cc-4bc4-95e0-062fee836398", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-14c9674e-36cc-4bc4-95e0-062fee836398" }, { "name": "release_payment", "item": [ { "name": "Release Payment (Deprecated - Do Not Use)", "id": "5fc2a2b1-b5b5-4d99-96d3-cbdbc517d5f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"release_amount\": \"\",\n \"flag_release\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id/release_payment", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "release_payment" ], "variable": [ { "id": "5e0d2fe2-ffd4-40ac-990a-eb3517b15533", "key": "id", "value": "7190770-1-2908", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Included for legacy purposes for existing customers that use Escrow payments which are no longer supported for new flows/customers. Release funds held in escrow from an **Item** with an **Escrow** or **Escrow Partial Release** payment type. This will transition the **Item** state to `completed`." }, "response": [ { "id": "b82d9a4c-e96c-488c-9dab-53d3d1e72f97", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"release_amount\": \"\",\n \"flag_release\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id/release_payment", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id", "release_payment" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"completed\",\n \"status\": 22190,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-b82d9a4c-e96c-488c-9dab-53d3d1e72f97" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-5fc2a2b1-b5b5-4d99-96d3-cbdbc517d5f7" } ], "id": "52122949-8854-4ae1-82ae-cf5d794d28ff", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-52122949-8854-4ae1-82ae-cf5d794d28ff" }, { "name": "Show Item", "id": "aa8c7315-5227-4cd9-82f5-a9d47cf45969", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id" ], "variable": [ { "id": "6b0f5d4b-4010-4cc5-914d-3da78b3e3f2f", "key": "id", "value": "7190770-1-2908", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Show details of a specific **Item** using a given `:id`." }, "response": [ { "id": "5834f2ae-cf41-4a0f-a5ef-719c02a89d2e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"completed\",\n \"status\": 22190,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-5834f2ae-cf41-4a0f-a5ef-719c02a89d2e" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-aa8c7315-5227-4cd9-82f5-a9d47cf45969" }, { "name": "Delete Item", "id": "ebcffe2c-1434-434a-b049-4c19fc78afbf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id" ], "variable": [ { "id": "42afadc4-6ebe-486f-bcb3-8bfa67731ca0", "key": "id", "value": "7190770-1-2908", "description": "(Required) Marketplace / Platform item ID" } ] }, "description": "Delete an existing **Item** using a given `:id`." }, "response": [ { "id": "7f35de68-2bfd-4357-a0b9-8f706603c221", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"completed\",\n \"status\": 22190,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-7f35de68-2bfd-4357-a0b9-8f706603c221" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-ebcffe2c-1434-434a-b049-4c19fc78afbf" }, { "name": "Update Item", "id": "8eb2f7fa-808a-4fb5-8473-c7033691f42d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"name\": \"\",\n \"buyer_id\": \"\",\n \"seller_id\": \"\",\n \"description\": \"\",\n \"custom_descriptor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id" ], "variable": [ { "id": "395a33e8-3be9-404b-8132-9261c5f01b8b", "key": "id", "value": "7190770-1-2908", "description": "(Required) Item ID" } ] }, "description": "Update an existing **Items** attributes using a given `:id`. Note: An item can only be updated if it's in `pending` state. Once an item has begun a payment process, you cannot update it.\n" }, "response": [ { "id": "6bbc449e-5e55-437a-a4f7-30ca2dbeee6e", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"name\": \"\",\n \"buyer_id\": \"\",\n \"seller_id\": \"\",\n \"description\": \"\",\n \"custom_descriptor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "items", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"completed\",\n \"status\": 22190,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-6bbc449e-5e55-437a-a4f7-30ca2dbeee6e" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-8eb2f7fa-808a-4fb5-8473-c7033691f42d" } ], "id": "a439564b-4819-44b5-8b6d-0a4ff69c510a", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-a439564b-4819-44b5-8b6d-0a4ff69c510a" }, { "name": "List Items", "id": "5a901464-7dee-4e53-aa49-e9e81804ad69", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/items?offset=0&limit=10&search=&created_before=&created_after=", "host": [ "{{baseUrl}}" ], "path": [ "items" ], "query": [ { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "(Required) A text value to be used for searching within the item description", "key": "search", "value": "" }, { "description": "Date and time in ISO 8601 format the item(s) were created before (e.g. 2020-02-27T23:54:59Z)", "key": "created_before", "value": "" }, { "description": "Date and time in ISO 8601 format the item(s) were created after (e.g. 2020-02-27T23:54:59Z)", "key": "created_after", "value": "" } ] }, "description": "OK" }, "response": [ { "id": "08e633c7-ca88-4072-b517-26368cb79c73", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/items?offset=0&limit=10&search=&created_before=&created_after=", "host": [ "{{baseUrl}}" ], "path": [ "items" ], "query": [ { "description": "Number of records to offset. Required for pagination.", "key": "offset", "value": "0" }, { "description": "Number of records to retrieve. Up to 200.", "key": "limit", "value": "10" }, { "description": "(Required) A text value to be used for searching within the item description", "key": "search", "value": "" }, { "description": "Date and time in ISO 8601 format the item(s) were created before (e.g. 2020-02-27T23:54:59Z)", "key": "created_before", "value": "" }, { "description": "Date and time in ISO 8601 format the item(s) were created after (e.g. 2020-02-27T23:54:59Z)", "key": "created_after", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"payment_held\",\n \"status\": 22400,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"partial_paid\",\n \"status\": 22500,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n ],\n \"links\": {\n \"self\": \"\"\n },\n \"meta\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-08e633c7-ca88-4072-b517-26368cb79c73" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-5a901464-7dee-4e53-aa49-e9e81804ad69" }, { "name": "Create Item", "id": "05d2967c-5c1c-40b7-8293-86d1fb8fd0df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"7190770-1-2908\",\n \"name\": \"Item 7190770-1-2908\",\n \"amount\": \"102\",\n \"payment_type\": \"2\",\n \"buyer_id\": \"buyer-719013950014\",\n \"seller_id\": \"seller-71718579\",\n \"currency\": \"\",\n \"fee_ids\": \"\",\n \"description\": \"\",\n \"buyer_url\": \"\",\n \"seller_url\": \"\",\n \"tax_invoice\": \"\",\n \"custom_descriptor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items", "host": [ "{{baseUrl}}" ], "path": [ "items" ] }, "description": "Create an **Item**. Items require two **Users**, a buyer and a seller. The `buyer_id` and `seller_id` are your unique user identifiers.\n" }, "response": [ { "id": "d5df6c40-4918-436d-9ebe-c21b7f7d3937", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"7190770-1-2908\",\n \"name\": \"Item 7190770-1-2908\",\n \"amount\": \"102\",\n \"payment_type\": \"2\",\n \"buyer_id\": \"buyer-719013950014\",\n \"seller_id\": \"seller-71718579\",\n \"currency\": \"\",\n \"fee_ids\": \"\",\n \"description\": \"\",\n \"buyer_url\": \"\",\n \"seller_url\": \"\",\n \"tax_invoice\": \"\",\n \"custom_descriptor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/items", "host": [ "{{baseUrl}}" ], "path": [ "items" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": {\n \"id\": \"\",\n \"name\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"state\": \"completed\",\n \"status\": 22190,\n \"payment_type_id\": \"\",\n \"currency\": \"\",\n \"buyer_name\": \"\",\n \"buyer_email\": \"\",\n \"buyer_country\": \"\",\n \"seller_name\": \"\",\n \"seller_email\": \"\",\n \"seller_country\": \"\",\n \"tds_check_state\": \"\",\n \"batch_state\": \"\",\n \"invoice_url\": \"\",\n \"payout_descriptor\": \"\",\n \"remaining_amount\": \"\",\n \"requested_release_amount\": \"\",\n \"custom_descriptor\": \"\",\n \"net_amount\": \"\",\n \"chargedback_amount\": \"\",\n \"refunded_amount\": \"\",\n \"released_amount\": \"\",\n \"buyer_fees\": \"\",\n \"seller_fees\": \"\",\n \"credit_card_fee\": \"\",\n \"paypal_fee\": \"\",\n \"seller_url\": \"\",\n \"buyer_url\": \"\",\n \"direct_debit_fee\": \"\",\n \"due_date\": \"\",\n \"pending_release_amount\": \"\",\n \"dynamic_descriptor\": \"\",\n \"deposit_reference\": \"\",\n \"promisepay_fee\": \"\",\n \"total_outstanding\": \"\",\n \"total_amount\": \"\",\n \"payment_method\": \"\",\n \"payment_credit_card_enabled\": \"\",\n \"payment_direct_debit_enabled\": \"\",\n \"related\": {\n \"buyers\": \"\",\n \"sellers\": \"\"\n },\n \"links\": {\n \"self\": \"\",\n \"buyers\": \"\",\n \"sellers\": \"\",\n \"status\": \"\",\n \"fees\": \"\",\n \"transactions\": \"\",\n \"batch_transactions\": \"\",\n \"wire_details\": \"\",\n \"bpay_details\": \"\",\n \"tds_checks\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-d5df6c40-4918-436d-9ebe-c21b7f7d3937" } ], "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-05d2967c-5c1c-40b7-8293-86d1fb8fd0df" } ], "id": "cb367c91-7730-41c5-a672-15dcde242073", "createdAt": "2026-07-28T03:36:47.000Z", "updatedAt": "2026-07-28T03:36:47.000Z", "uid": "35240-cb367c91-7730-41c5-a672-15dcde242073" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "accessTokenUrl", "value": "https://au-0000.sandbox.auth.assemblypay.com/tokens", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://test.api.promisepay.com" } ] }