{ "info": { "_postman_id": "c794bd84-0fea-4e47-9d74-98910e9af7a9", "name": "Zepto API", "description": "Zepto allows you to make, get and manage payments using nothing but bank accounts.\n\nContact Support:\n Email: support@zepto.com.au", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:37:22.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "lastUpdatedBy": "35240", "uid": "35240-c794bd84-0fea-4e47-9d74-98910e9af7a9" }, "item": [ { "name": "agreements", "item": [ { "name": "outgoing", "item": [ { "name": "List Agreements", "id": "2d2fa035-9c90-4f97-aeaa-8290434f55d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/agreements/outgoing?page=&per_page=&authoriser_id=&contact_id=&status=declined", "host": [ "{{baseUrl}}" ], "path": [ "agreements", "outgoing" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" }, { "description": "Authoriser ID (`Contact.data.account.id`), single value, exact match", "key": "authoriser_id", "value": "" }, { "description": "Contact ID (`Contact.data.id`), single value, exact match", "key": "contact_id", "value": "" }, { "description": "Exact match", "key": "status", "value": "declined" } ] }, "description": "By default, all outgoing Agreements will be returned. You can apply filters to your query to customise the returned Agreements." }, "response": [ { "id": "5734eda2-0f07-4d35-8b4c-cdc7fca19bdf", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/agreements/outgoing?page=&per_page=&authoriser_id=&contact_id=&status=declined", "host": [ "{{baseUrl}}" ], "path": [ "agreements", "outgoing" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" }, { "description": "Authoriser ID (`Contact.data.account.id`), single value, exact match", "key": "authoriser_id", "value": "" }, { "description": "Contact ID (`Contact.data.id`), single value, exact match", "key": "contact_id", "value": "" }, { "description": "Exact match", "key": "status", "value": "declined" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Per-Page", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": []\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-5734eda2-0f07-4d35-8b4c-cdc7fca19bdf" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-2d2fa035-9c90-4f97-aeaa-8290434f55d9" } ], "id": "203f93af-867c-449a-bc89-2304214cb159", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-203f93af-867c-449a-bc89-2304214cb159" }, { "name": "{agreement_ref}", "item": [ { "name": "Get an Agreement", "id": "9e0ddc38-531d-40d6-988e-9d6bacbdbc51", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_ref", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_ref" ], "variable": [ { "id": "643f6d26-35d0-4e49-b234-1a0b111b43f3", "key": "agreement_ref", "value": "7`K|A^q", "description": "(Required) Single value, exact match" } ] }, "description": "Get a single Agreement by its reference" }, "response": [ { "id": "c6f79da6-e0fe-464d-a7d4-e25160c07661", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_ref", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_ref" ], "variable": [ { "key": "agreement_ref" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"ref\": \"\",\n \"initiator_id\": \"\",\n \"authoriser_id\": \"\",\n \"contact_id\": \"\",\n \"bank_account_id\": \"\",\n \"status\": \"accepted\",\n \"status_reason\": \"\",\n \"responded_at\": \"\",\n \"created_at\": \"\",\n \"terms\": {\n \"per_payout\": {\n \"min_amount\": \"\",\n \"max_amount\": \"\"\n },\n \"per_frequency\": {\n \"days\": \"\",\n \"max_amount\": \"\"\n }\n },\n \"metadata\": {}\n }\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-c6f79da6-e0fe-464d-a7d4-e25160c07661" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-9e0ddc38-531d-40d6-988e-9d6bacbdbc51" }, { "name": "Cancel an Agreement", "id": "34ff2247-92f2-4eab-9bb0-55ffafad5c07", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_ref", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_ref" ], "variable": [ { "id": "511f3e0a-3efa-45fb-8f0e-d78f5e99b380", "key": "agreement_ref", "value": "7`K|A^q", "description": "(Required) Single value, exact match." } ] }, "description": "An Agreement can be cancelled by the initiator at any time whilst the authoriser (Agreement recipient) can only cancel a previously accepted Agreement." }, "response": [ { "id": "4d384840-3796-4a7d-b265-be96b43453c0", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_ref", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_ref" ], "variable": [ { "key": "agreement_ref" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-4d384840-3796-4a7d-b265-be96b43453c0" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-34ff2247-92f2-4eab-9bb0-55ffafad5c07" } ], "id": "7e03eb68-0171-4977-bf48-cd5e623899d2", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-7e03eb68-0171-4977-bf48-cd5e623899d2" } ], "id": "1b2b89cd-3681-4e05-b35a-d68cc1a1dc64", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-1b2b89cd-3681-4e05-b35a-d68cc1a1dc64" }, { "name": "bank_accounts", "item": [ { "name": "{id}", "item": [ { "name": "Get a Bank Account", "id": "6b5b3936-29c0-4d97-8f4f-b8d8ca80f49c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:id", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":id" ], "variable": [ { "id": "33cdbbdd-919e-483d-ab2d-54fd2f357b89", "key": "id", "value": "", "description": "(Required) Bank Account ID (`BankAccount.data.id`), single value, exact match" } ] }, "description": "Returns a specified Bank or Float Account owned by your account. For a Float Account, the response includes its current `available_balance`." }, "response": [ { "id": "560474a4-960d-4828-8726-1ccf3ab7c4c1", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "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 \"data\": {\n \"account_type\": \"bank_account\",\n \"id\": \"\",\n \"branch_code\": \"\",\n \"bank_name\": \"\",\n \"account_number\": \"\",\n \"status\": \"active\",\n \"title\": \"\",\n \"available_balance\": \"\",\n \"payid_configs\": [\n {\n \"email_domain\": \"\",\n \"pooling_state\": \"disabled\",\n \"max_pool_size\": \"\",\n \"current_pool_size\": \"\"\n },\n {\n \"email_domain\": \"\",\n \"pooling_state\": \"disabled\",\n \"max_pool_size\": \"\",\n \"current_pool_size\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-560474a4-960d-4828-8726-1ccf3ab7c4c1" }, { "id": "5f68d71a-005a-4482-b0b8-1a2100ee3c60", "name": "Forbidden - the access token does not have the `bank_accounts` scope", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "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": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-5f68d71a-005a-4482-b0b8-1a2100ee3c60" }, { "id": "d91f2de7-1574-4064-9aa3-dc4b3bec58ae", "name": "Not Found - the Bank Account is unavailable or is not owned by the authenticated account", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "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": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-d91f2de7-1574-4064-9aa3-dc4b3bec58ae" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-6b5b3936-29c0-4d97-8f4f-b8d8ca80f49c" } ], "id": "50a5b522-aa53-4060-a7dc-b8fdb6b98a93", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-50a5b522-aa53-4060-a7dc-b8fdb6b98a93" }, { "name": "{bank_account_id}", "item": [ { "name": "entries", "item": [ { "name": "{entry_id}", "item": [ { "name": "Get a Float Account entry", "id": "f4d4ea3a-e47f-4d1a-9b17-826d4de0def9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:bank_account_id/entries/:entry_id", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":bank_account_id", "entries", ":entry_id" ], "variable": [ { "id": "aee16c31-e2fd-4acc-82b2-d020243fc407", "key": "bank_account_id", "value": "", "description": "(Required) Bank Account ID (`BankAccount.data.id`), single value, exact match" }, { "id": "4957f66f-f8fd-4a21-a5be-725933d1751a", "key": "entry_id", "value": "", "description": "(Required) Float Account entry ID (`FloatAccountEntry.data.id`), single value, exact match" } ] }, "description": "Gets one settled entry applied to a Float Account.\n\nFloat Account entries are available through this API for a rolling 24-month period, calculated from the time of the request." }, "response": [ { "id": "1d34bb90-fe46-4b4c-ae12-c153754be2ea", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:bank_account_id/entries/:entry_id", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":bank_account_id", "entries", ":entry_id" ], "variable": [ { "key": "bank_account_id" }, { "key": "entry_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"available_balance_after\": \"\",\n \"links\": {\n \"self\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-1d34bb90-fe46-4b4c-ae12-c153754be2ea" }, { "id": "78dd9890-4d3f-48ae-964c-020cf44e5367", "name": "Forbidden - the access token does not have the `bank_accounts` scope", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:bank_account_id/entries/:entry_id", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":bank_account_id", "entries", ":entry_id" ], "variable": [ { "key": "bank_account_id" }, { "key": "entry_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-78dd9890-4d3f-48ae-964c-020cf44e5367" }, { "id": "d0fff7ca-4e42-4c27-b20b-c5d370eaedd3", "name": "Not Found - the Bank Account or entry is unavailable, the entry is outside the rolling 24-month availability window, or the Bank Account is not a Float Account", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:bank_account_id/entries/:entry_id", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":bank_account_id", "entries", ":entry_id" ], "variable": [ { "key": "bank_account_id" }, { "key": "entry_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-d0fff7ca-4e42-4c27-b20b-c5d370eaedd3" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-f4d4ea3a-e47f-4d1a-9b17-826d4de0def9" } ], "id": "45d74c12-dd84-42e1-8e21-461e158cfd46", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-45d74c12-dd84-42e1-8e21-461e158cfd46" }, { "name": "List Float Account entries", "id": "2b9e714e-4467-4287-b0b0-0aaa6b39555b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:bank_account_id/entries?min_created_date=&max_created_date=&per_page=20&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":bank_account_id", "entries" ], "query": [ { "description": "Filter by minimum `created_at`. The value must not be earlier than the start of the rolling 24-month availability window. Date/time UTC ISO 8601 format, single value, exact match.", "key": "min_created_date", "value": "" }, { "description": "Filter by maximum `created_at`. The value must not be earlier than the start of the rolling 24-month availability window. Date/time UTC ISO 8601 format, single value, exact match.", "key": "max_created_date", "value": "" }, { "description": "Number of entries to return. Defaults to 20 and is constrained to 1\u2013100.", "key": "per_page", "value": "20" }, { "description": "ID of the final entry from the previous page. Return the value from the `Link` header unchanged.", "key": "starting_after", "value": "" } ], "variable": [ { "id": "327d5085-b075-4ad0-80d9-addd907b1a4e", "key": "bank_account_id", "value": "", "description": "(Required) Bank Account ID (`BankAccount.data.id`), single value, exact match" } ] }, "description": "Lists the settled ledger entries applied to a Float Account. Transactions and Transfers describe business operations; entries describe what was posted to this Float Account and changed its available balance. An entry may result from a payment, transfer, refund, recovery, return, fee, or manual adjustment, making this endpoint the complete account-level record within the availability window for reconciliation.\n\nFloat Account entries are available through this API for a rolling 24-month period, calculated from the time of the request. Entries created before the start of that window are not returned. Requests with either created-at filter before the start of the window return `422 Unprocessable Entity`.\n\nEntries are returned in descending order by `created_at` and then `id`. The ID is a deterministic tie-breaker; entries with the same timestamp are not guaranteed to be returned in their original balance-application order.\n\n`amount` is expressed in cents. Positive values credit the Float Account and negative values debit it." }, "response": [ { "id": "e1e1eff4-09fe-45a7-a2f9-d1057ce4b289", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:bank_account_id/entries?min_created_date=&max_created_date=&per_page=20&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":bank_account_id", "entries" ], "query": [ { "description": "Filter by minimum `created_at`. The value must not be earlier than the start of the rolling 24-month availability window. Date/time UTC ISO 8601 format, single value, exact match.", "key": "min_created_date", "value": "" }, { "description": "Filter by maximum `created_at`. The value must not be earlier than the start of the rolling 24-month availability window. Date/time UTC ISO 8601 format, single value, exact match.", "key": "max_created_date", "value": "" }, { "description": "Number of entries to return. Defaults to 20 and is constrained to 1\u2013100.", "key": "per_page", "value": "20" }, { "description": "ID of the final entry from the previous page. Return the value from the `Link` header unchanged.", "key": "starting_after", "value": "" } ], "variable": [ { "key": "bank_account_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Contains the next-page URL when another page exists", "type": "text/plain" }, "key": "Link", "value": "" }, { "disabled": false, "description": { "content": "Contains the maximum number of entries requested for this page. Defaults to 20.", "type": "text/plain" }, "key": "Per-Page", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"available_balance_after\": \"\",\n \"links\": {\n \"self\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"available_balance_after\": \"\",\n \"links\": {\n \"self\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-e1e1eff4-09fe-45a7-a2f9-d1057ce4b289" }, { "id": "d833935f-307e-4103-b94e-2468c752aa3a", "name": "Bad Request - `per_page` is not an integer", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:bank_account_id/entries?min_created_date=&max_created_date=&per_page=20&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":bank_account_id", "entries" ], "query": [ { "description": "Filter by minimum `created_at`. The value must not be earlier than the start of the rolling 24-month availability window. Date/time UTC ISO 8601 format, single value, exact match.", "key": "min_created_date", "value": "" }, { "description": "Filter by maximum `created_at`. The value must not be earlier than the start of the rolling 24-month availability window. Date/time UTC ISO 8601 format, single value, exact match.", "key": "max_created_date", "value": "" }, { "description": "Number of entries to return. Defaults to 20 and is constrained to 1\u2013100.", "key": "per_page", "value": "20" }, { "description": "ID of the final entry from the previous page. Return the value from the `Link` header unchanged.", "key": "starting_after", "value": "" } ], "variable": [ { "key": "bank_account_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-d833935f-307e-4103-b94e-2468c752aa3a" }, { "id": "5f1fc3f8-bcf7-45b2-9a8f-2c74e690d1bc", "name": "Forbidden - the access token does not have the `bank_accounts` scope", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:bank_account_id/entries?min_created_date=&max_created_date=&per_page=20&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":bank_account_id", "entries" ], "query": [ { "description": "Filter by minimum `created_at`. The value must not be earlier than the start of the rolling 24-month availability window. Date/time UTC ISO 8601 format, single value, exact match.", "key": "min_created_date", "value": "" }, { "description": "Filter by maximum `created_at`. The value must not be earlier than the start of the rolling 24-month availability window. Date/time UTC ISO 8601 format, single value, exact match.", "key": "max_created_date", "value": "" }, { "description": "Number of entries to return. Defaults to 20 and is constrained to 1\u2013100.", "key": "per_page", "value": "20" }, { "description": "ID of the final entry from the previous page. Return the value from the `Link` header unchanged.", "key": "starting_after", "value": "" } ], "variable": [ { "key": "bank_account_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-5f1fc3f8-bcf7-45b2-9a8f-2c74e690d1bc" }, { "id": "196c49f8-a8c6-44b8-9e44-92dde2c23257", "name": "Not Found - the Bank Account is unavailable or is not a Float Account", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:bank_account_id/entries?min_created_date=&max_created_date=&per_page=20&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":bank_account_id", "entries" ], "query": [ { "description": "Filter by minimum `created_at`. The value must not be earlier than the start of the rolling 24-month availability window. Date/time UTC ISO 8601 format, single value, exact match.", "key": "min_created_date", "value": "" }, { "description": "Filter by maximum `created_at`. The value must not be earlier than the start of the rolling 24-month availability window. Date/time UTC ISO 8601 format, single value, exact match.", "key": "max_created_date", "value": "" }, { "description": "Number of entries to return. Defaults to 20 and is constrained to 1\u2013100.", "key": "per_page", "value": "20" }, { "description": "ID of the final entry from the previous page. Return the value from the `Link` header unchanged.", "key": "starting_after", "value": "" } ], "variable": [ { "key": "bank_account_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-196c49f8-a8c6-44b8-9e44-92dde2c23257" }, { "id": "a478b2a0-eedf-4157-befc-12c64fd95d53", "name": "Unprocessable Entity - `starting_after` is not an available entry in this Float Account, or a `created_at` filter is invalid or outside the rolling 24-month availability window", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts/:bank_account_id/entries?min_created_date=&max_created_date=&per_page=20&starting_after=", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts", ":bank_account_id", "entries" ], "query": [ { "description": "Filter by minimum `created_at`. The value must not be earlier than the start of the rolling 24-month availability window. Date/time UTC ISO 8601 format, single value, exact match.", "key": "min_created_date", "value": "" }, { "description": "Filter by maximum `created_at`. The value must not be earlier than the start of the rolling 24-month availability window. Date/time UTC ISO 8601 format, single value, exact match.", "key": "max_created_date", "value": "" }, { "description": "Number of entries to return. Defaults to 20 and is constrained to 1\u2013100.", "key": "per_page", "value": "20" }, { "description": "ID of the final entry from the previous page. Return the value from the `Link` header unchanged.", "key": "starting_after", "value": "" } ], "variable": [ { "key": "bank_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 {\n \"title\": \"\",\n \"detail\": \"\"\n },\n {\n \"title\": \"\",\n \"detail\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-a478b2a0-eedf-4157-befc-12c64fd95d53" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-2b9e714e-4467-4287-b0b0-0aaa6b39555b" } ], "id": "454c7e95-0f0d-4ae7-8147-e7f39b441fe7", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-454c7e95-0f0d-4ae7-8147-e7f39b441fe7" } ], "id": "532905b5-743f-4406-bb03-a010344df5ff", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-532905b5-743f-4406-bb03-a010344df5ff" }, { "name": "List all Bank Accounts", "id": "bba2f8ba-81f0-47e9-bc63-434665e27ec0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/bank_accounts", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts" ] }, "description": "By default, all Bank Accounts will be returned.\n" }, "response": [ { "id": "5952195f-8e9e-4ffc-8342-fc596d305cfc", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/bank_accounts", "host": [ "{{baseUrl}}" ], "path": [ "bank_accounts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Per-Page", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"account_type\": \"float_account\",\n \"id\": \"\",\n \"branch_code\": \"\",\n \"bank_name\": \"\",\n \"account_number\": \"\",\n \"status\": \"active\",\n \"title\": \"\",\n \"available_balance\": \"\",\n \"payid_configs\": [\n {\n \"email_domain\": \"\",\n \"pooling_state\": \"paused\",\n \"max_pool_size\": \"\",\n \"current_pool_size\": \"\"\n },\n {\n \"email_domain\": \"\",\n \"pooling_state\": \"enabled\",\n \"max_pool_size\": \"\",\n \"current_pool_size\": \"\"\n }\n ]\n },\n {\n \"account_type\": \"bank_account\",\n \"id\": \"\",\n \"branch_code\": \"\",\n \"bank_name\": \"\",\n \"account_number\": \"\",\n \"status\": \"removed\",\n \"title\": \"\",\n \"available_balance\": \"\",\n \"payid_configs\": [\n {\n \"email_domain\": \"\",\n \"pooling_state\": \"enabled\",\n \"max_pool_size\": \"\",\n \"current_pool_size\": \"\"\n },\n {\n \"email_domain\": \"\",\n \"pooling_state\": \"paused\",\n \"max_pool_size\": \"\",\n \"current_pool_size\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-5952195f-8e9e-4ffc-8342-fc596d305cfc" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-bba2f8ba-81f0-47e9-bc63-434665e27ec0" } ], "id": "d2c4a0a3-6c67-4b0c-9c24-d3e243b51997", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-d2c4a0a3-6c67-4b0c-9c24-d3e243b51997" }, { "name": "contacts", "item": [ { "name": "anyone", "item": [ { "name": "Add a Contact", "id": "175a389e-c3d9-4a4a-81b9-739b6f558126", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"n\",\n \"email\": \"\",\n \"branch_code\": \"\",\n \"account_number\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/anyone", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "anyone" ] }, "description": "Use this endpoint when you want to pay somebody.\n\n\n" }, "response": [ { "id": "8a65f4a1-89fc-4c89-aedc-9058b5aca309", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "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\": \"n\",\n \"email\": \"\",\n \"branch_code\": \"\",\n \"account_number\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/anyone", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "anyone" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-8a65f4a1-89fc-4c89-aedc-9058b5aca309" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-175a389e-c3d9-4a4a-81b9-739b6f558126" } ], "id": "a803159f-c45f-44a2-9295-ddbef580b883", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-a803159f-c45f-44a2-9295-ddbef580b883" }, { "name": "receivable", "item": [ { "name": "Add a Receivable Contact", "id": "7c3c48d4-88ac-4e5f-b484-b60e6896deab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"NU+Gp5UN7J\",\n \"email\": \"\",\n \"payid_email\": \"\",\n \"payid_email_domain\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/receivable", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "receivable" ] }, "description": "Receive funds from a Contact by allowing them to pay to a personalised PayID or account number. Perfect for reconciling incoming funds to a customer, receiving funds instantly, eliminating human error & improving your customer's experience.\n\n\n\n\n\n\n" }, "response": [ { "id": "11462e0e-d039-4785-a448-cee66ab46d79", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "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\": \"NU+Gp5UN7J\",\n \"email\": \"\",\n \"payid_email\": \"\",\n \"payid_email_domain\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/receivable", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "receivable" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"\",\n \"metadata\": {},\n \"bank_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"branch_code\": \"\",\n \"bank_name\": \"\",\n \"state\": \"active\",\n \"iav_provider\": \"\",\n \"iav_status\": \"\",\n \"blocks\": {\n \"debits_blocked\": \"\",\n \"credits_blocked\": \"\"\n }\n },\n \"anyone_account\": {\n \"id\": \"\"\n },\n \"payid_details\": {\n \"alias_value\": \"\",\n \"alias_type\": \"\",\n \"alias_name\": \"\",\n \"state\": \"pending\"\n }\n }\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-11462e0e-d039-4785-a448-cee66ab46d79" }, { "id": "8184923b-58f3-481a-af0c-87b2155fa111", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"NU+Gp5UN7J\",\n \"email\": \"\",\n \"payid_email\": \"\",\n \"payid_email_domain\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/receivable", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "receivable" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-8184923b-58f3-481a-af0c-87b2155fa111" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-7c3c48d4-88ac-4e5f-b484-b60e6896deab" } ], "id": "87643ed6-3f44-4dbe-8a69-09e82a2ed2e0", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-87643ed6-3f44-4dbe-8a69-09e82a2ed2e0" }, { "name": "{contact_id}", "item": [ { "name": "receivable", "item": [ { "name": "disable", "item": [ { "name": "Disable a Receivable Contact", "id": "6f74f3a4-9f92-46c5-9a61-0e3d30ebd5fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" } ], "url": { "raw": "{{baseUrl}}/contacts/:contact_id/receivable/disable", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contact_id", "receivable", "disable" ], "variable": [ { "id": "603038f0-ec00-4502-b6f2-c21eb44dec9d", "key": "contact_id", "value": "", "description": "(Required) Receivable Contact ID (`ReceivableContact.data.id`)" } ] }, "description": "This endpoint should be used to Disable a Receivable Contact.\n\nThis will reject all payments made to the relevant Account number or PayID and return them to your customer. Payments made via DE and NPP will be rejected.\n" }, "response": [ { "id": "0704cf41-da50-4a73-8436-a49db4e94115", "name": "No Content (success)", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:contact_id/receivable/disable", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contact_id", "receivable", "disable" ], "variable": [ { "key": "contact_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-0704cf41-da50-4a73-8436-a49db4e94115" }, { "id": "472844d8-3d80-4b18-a937-70b9f80367d6", "name": "Bad Request (errors)", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:contact_id/receivable/disable", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contact_id", "receivable", "disable" ], "variable": [ { "key": "contact_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-472844d8-3d80-4b18-a937-70b9f80367d6" }, { "id": "05024a82-9736-4b7d-99f9-2228c7dbfde6", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:contact_id/receivable/disable", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contact_id", "receivable", "disable" ], "variable": [ { "key": "contact_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-05024a82-9736-4b7d-99f9-2228c7dbfde6" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-6f74f3a4-9f92-46c5-9a61-0e3d30ebd5fa" } ], "id": "0cfbcaf6-2e8a-4282-8909-cf8c47058a65", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-0cfbcaf6-2e8a-4282-8909-cf8c47058a65" }, { "name": "activate", "item": [ { "name": "Reactivate a Receivable Contact", "id": "7e3987d4-b5da-4a8d-8923-817fca3bb339", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/contacts/:contact_id/receivable/activate", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contact_id", "receivable", "activate" ], "variable": [ { "id": "70a8bc0c-df27-4c00-9bd3-f28eccf29f41", "key": "contact_id", "value": "", "description": "(Required) Receivable Contact ID (`ReceivableContact.data.id`)" } ] }, "description": "This endpoint should be used to Reactivate a Receivable Contact that has been previously Disabled.\n\nThis will once again allow you to receive funds from your customer via both DE and NPP channels.\n" }, "response": [ { "id": "858ffd9f-5bf4-42de-b03e-ed213a274f55", "name": "No Content (success)", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:contact_id/receivable/activate", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contact_id", "receivable", "activate" ], "variable": [ { "key": "contact_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-858ffd9f-5bf4-42de-b03e-ed213a274f55" }, { "id": "1b112dbe-6b0b-4030-9f4e-2fa0b1780025", "name": "Bad Request (errors)", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:contact_id/receivable/activate", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contact_id", "receivable", "activate" ], "variable": [ { "key": "contact_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": \"\"\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-1b112dbe-6b0b-4030-9f4e-2fa0b1780025" }, { "id": "ea5f6261-657d-44de-a73b-0f0ef8c167cc", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:contact_id/receivable/activate", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contact_id", "receivable", "activate" ], "variable": [ { "key": "contact_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-ea5f6261-657d-44de-a73b-0f0ef8c167cc" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-7e3987d4-b5da-4a8d-8923-817fca3bb339" } ], "id": "e0084d3c-886a-4a14-8898-4f6a6671f4b1", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-e0084d3c-886a-4a14-8898-4f6a6671f4b1" }, { "name": "Update a Receivable Contact", "id": "4916a1db-b1e4-4a02-af84-27580c5487f3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payid_name\": \"@OQC>\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/:contact_id/receivable", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contact_id", "receivable" ], "variable": [ { "id": "f8220db1-00ab-4fd9-851f-9e63be2de964", "key": "contact_id", "value": "", "description": "(Required) Receivable Contact ID (`ReceivableContact.data.id`)" } ] }, "description": "You can update the PayID name of a Receivable Contact.\n\n\n" }, "response": [ { "id": "adc87d6b-8de1-4574-a19a-d52bb2523f0b", "name": "Accepted", "originalRequest": { "method": "PATCH", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"payid_name\": \"@OQC>\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/:contact_id/receivable", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contact_id", "receivable" ], "variable": [ { "key": "contact_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-adc87d6b-8de1-4574-a19a-d52bb2523f0b" }, { "id": "6d0c86ce-e568-4d3f-8368-889c11c8f84b", "name": "Bad Request (errors)", "originalRequest": { "method": "PATCH", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"payid_name\": \"@OQC>\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/:contact_id/receivable", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contact_id", "receivable" ], "variable": [ { "key": "contact_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-6d0c86ce-e568-4d3f-8368-889c11c8f84b" }, { "id": "4245e9b8-0d66-4238-86d6-a28c4b1b319c", "name": "Not Found", "originalRequest": { "method": "PATCH", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"payid_name\": \"@OQC>\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/:contact_id/receivable", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":contact_id", "receivable" ], "variable": [ { "key": "contact_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-4245e9b8-0d66-4238-86d6-a28c4b1b319c" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-4916a1db-b1e4-4a02-af84-27580c5487f3" } ], "id": "7ef211bb-7bc1-4d7d-952f-bab9e195b594", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-7ef211bb-7bc1-4d7d-952f-bab9e195b594" } ], "id": "dde8b789-cb08-4c36-a501-efa61f62ce31", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-dde8b789-cb08-4c36-a501-efa61f62ce31" }, { "name": "{id}", "item": [ { "name": "Get a Contact", "id": "c0328ca0-5a8b-45f3-870c-91f7aa2d67ad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "id": "e7bbc81e-bd0b-4cf6-b5a9-295bb8219f74", "key": "id", "value": "", "description": "(Required) Contact ID (`Contact.data.id`)" } ] }, "description": "Get a single Contact by its ID" }, "response": [ { "id": "9d2706a4-f6a9-4e1e-a1ab-1e21f966e795", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"ref\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"type\": \"Zepto account\",\n \"metadata\": {},\n \"bank_account\": {\n \"id\": \"\",\n \"account_number\": \"\",\n \"branch_code\": \"\",\n \"state\": \"active\",\n \"iav_provider\": \"basiq\",\n \"iav_status\": \"removed\",\n \"blocks\": {\n \"debits_blocked\": \"\",\n \"credits_blocked\": \"\"\n }\n },\n \"anyone_account\": {\n \"id\": \"\"\n },\n \"bank_connection\": {\n \"id\": \"\"\n },\n \"links\": {\n \"add_bank_connection\": \"\"\n },\n \"payid_details\": {\n \"alias_value\": \"\",\n \"alias_type\": \"\",\n \"alias_name\": \"\",\n \"state\": \"pending\"\n }\n }\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-9d2706a4-f6a9-4e1e-a1ab-1e21f966e795" }, { "id": "7b9c29b3-f7fc-47b6-a44d-d63b174ad8b1", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-7b9c29b3-f7fc-47b6-a44d-d63b174ad8b1" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-c0328ca0-5a8b-45f3-870c-91f7aa2d67ad" }, { "name": "Remove a Contact", "id": "46556378-51b5-4ffd-bf24-5dbd6a1b2608", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" } ], "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "id": "09334e99-c0fa-4916-949f-4f7d42ebd70c", "key": "id", "value": "", "description": "(Required) Contact ID (`Contact.data.id`)" } ] }, "description": "\n" }, "response": [ { "id": "58696493-f8b7-4822-9dca-33f545eaadb1", "name": "New Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-58696493-f8b7-4822-9dca-33f545eaadb1" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-46556378-51b5-4ffd-bf24-5dbd6a1b2608" }, { "name": "Update a Contact", "id": "390fff60-4478-4f2e-8a1b-ba12f2bb0422", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"%Yz\",\n \"email\": \"\",\n \"branch_code\": \"\",\n \"account_number\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "id": "763d5ad7-5e6f-4bbd-bf0f-1dc15a14de15", "key": "id", "value": "", "description": "(Required) Contact ID (`Contact.data.id`)" } ] }, "description": "You can update the name, email, bank account and metadata of any Contact.\n\n" }, "response": [ { "id": "5bdf764e-5602-43a6-804d-d071b0d49ed3", "name": "OK", "originalRequest": { "method": "PATCH", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "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\": \"%Yz\",\n \"email\": \"\",\n \"branch_code\": \"\",\n \"account_number\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-5bdf764e-5602-43a6-804d-d071b0d49ed3" }, { "id": "df903159-6416-4074-803e-3b6d013265a7", "name": "Not Found", "originalRequest": { "method": "PATCH", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"%Yz\",\n \"email\": \"\",\n \"branch_code\": \"\",\n \"account_number\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-df903159-6416-4074-803e-3b6d013265a7" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-390fff60-4478-4f2e-8a1b-ba12f2bb0422" } ], "id": "32eea4e4-8327-4336-9dbc-6d9e2ded7dcd", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-32eea4e4-8327-4336-9dbc-6d9e2ded7dcd" }, { "name": "List all Contacts", "id": "5ae37b7d-a4df-4730-9c1a-aec2dd027d7d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/contacts?page=&per_page=&name=&nickname=&email=&bank_account_id=&bank_account_branch_code=&bank_account_account_number=", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" }, { "description": "Single value, string search", "key": "name", "value": "" }, { "description": "Single value, string search", "key": "nickname", "value": "" }, { "description": "Single value, string search", "key": "email", "value": "" }, { "description": "Single value, exact match", "key": "bank_account_id", "value": "" }, { "description": "Single value, exact match", "key": "bank_account_branch_code", "value": "" }, { "description": "Single value, exact match", "key": "bank_account_account_number", "value": "" } ] }, "description": "By default, all Contacts will be returned. You can apply filters to your query to customise the returned Contact list.\n" }, "response": [ { "id": "5a6e2208-93f4-4c09-9d9a-4abc27955627", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/contacts?page=&per_page=&name=&nickname=&email=&bank_account_id=&bank_account_branch_code=&bank_account_account_number=", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" }, { "description": "Single value, string search", "key": "name", "value": "" }, { "description": "Single value, string search", "key": "nickname", "value": "" }, { "description": "Single value, string search", "key": "email", "value": "" }, { "description": "Single value, exact match", "key": "bank_account_id", "value": "" }, { "description": "Single value, exact match", "key": "bank_account_branch_code", "value": "" }, { "description": "Single value, exact match", "key": "bank_account_account_number", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Per-Page", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": []\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-5a6e2208-93f4-4c09-9d9a-4abc27955627" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-5ae37b7d-a4df-4730-9c1a-aec2dd027d7d" } ], "id": "4068277d-ea62-442a-8c30-dc3b50dce943", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-4068277d-ea62-442a-8c30-dc3b50dce943" }, { "name": "payments", "item": [ { "name": "{payment_ref}", "item": [ { "name": "Get a Payment", "id": "41756ca5-2dd8-4d9b-9251-506f6807555c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments/:payment_ref", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_ref" ], "variable": [ { "id": "e0fd78f5-414e-43ea-bf2b-23650654cbc5", "key": "payment_ref", "value": "", "description": "(Required) Payment reference" } ] }, "description": "Get a single payment by its reference" }, "response": [ { "id": "c0a92d9c-e7c9-4884-a8df-b91501baaa0d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payments/:payment_ref", "host": [ "{{baseUrl}}" ], "path": [ "payments", ":payment_ref" ], "variable": [ { "key": "payment_ref" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-c0a92d9c-e7c9-4884-a8df-b91501baaa0d" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-41756ca5-2dd8-4d9b-9251-506f6807555c" } ], "id": "6aa3d0b6-9f98-416d-a965-f2c8fc212de6", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-6aa3d0b6-9f98-416d-a965-f2c8fc212de6" }, { "name": "Make a Payment", "id": "cc9ebf48-c6bb-4f38-a5d6-b8006d53b871", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Idempotency key to support safe retries for 24h", "key": "Idempotency-Key", "value": "" }, { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"N2Y7\\\\b-(\",\n \"matures_at\": \"\",\n \"payouts\": [\n {\n \"amount\": \"\",\n \"description\": \"#?\",\n \"recipient_contact_id\": \"\",\n \"category_purpose_code\": \"PENS\",\n \"end_to_end_id\": \"\",\n \"metadata\": {}\n },\n {\n \"amount\": \"\",\n \"description\": \"s+ @\",\n \"recipient_contact_id\": \"\",\n \"category_purpose_code\": \"SALA\",\n \"end_to_end_id\": \"\",\n \"metadata\": {}\n }\n ],\n \"your_bank_account_id\": \"\",\n \"channels\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments", "host": [ "{{baseUrl}}" ], "path": [ "payments" ] }, "description": "To enable custom payment flows, the required payment channel can be selected by setting the _channel_ attribute to one of the following combinations:\n\n
    \n
  • [\"new_payments_platform\"] - for faster payments 24/7/365
    • \n
  • [\"direct_entry\"] - for slower traditional payments
    • \n
  • [\"new_payments_platform\", \"direct_entry\"] - enables automatic channel switching if a payment fails on the NPP
    • \n
\n\n" }, "response": [ { "id": "48409ad2-f5d5-4bce-948d-773dc0c9c277", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Idempotency key to support safe retries for 24h", "key": "Idempotency-Key", "value": "" }, { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "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 \"description\": \"N2Y7\\\\b-(\",\n \"matures_at\": \"\",\n \"payouts\": [\n {\n \"amount\": \"\",\n \"description\": \"#?\",\n \"recipient_contact_id\": \"\",\n \"category_purpose_code\": \"PENS\",\n \"end_to_end_id\": \"\",\n \"metadata\": {}\n },\n {\n \"amount\": \"\",\n \"description\": \"s+ @\",\n \"recipient_contact_id\": \"\",\n \"category_purpose_code\": \"SALA\",\n \"end_to_end_id\": \"\",\n \"metadata\": {}\n }\n ],\n \"your_bank_account_id\": \"\",\n \"channels\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments", "host": [ "{{baseUrl}}" ], "path": [ "payments" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-48409ad2-f5d5-4bce-948d-773dc0c9c277" }, { "id": "41f4059b-4219-4423-bccf-da863d1b2bd6", "name": "Bad Request (errors)", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Idempotency key to support safe retries for 24h", "key": "Idempotency-Key", "value": "" }, { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "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 \"description\": \"N2Y7\\\\b-(\",\n \"matures_at\": \"\",\n \"payouts\": [\n {\n \"amount\": \"\",\n \"description\": \"#?\",\n \"recipient_contact_id\": \"\",\n \"category_purpose_code\": \"PENS\",\n \"end_to_end_id\": \"\",\n \"metadata\": {}\n },\n {\n \"amount\": \"\",\n \"description\": \"s+ @\",\n \"recipient_contact_id\": \"\",\n \"category_purpose_code\": \"SALA\",\n \"end_to_end_id\": \"\",\n \"metadata\": {}\n }\n ],\n \"your_bank_account_id\": \"\",\n \"channels\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payments", "host": [ "{{baseUrl}}" ], "path": [ "payments" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": \"\"\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-41f4059b-4219-4423-bccf-da863d1b2bd6" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-cc9ebf48-c6bb-4f38-a5d6-b8006d53b871" }, { "name": "List all Payments", "id": "25ebfe89-952f-4933-9af2-fe11fd456f0e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payments?page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "payments" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" } ] } }, "response": [ { "id": "67eea3af-4cb4-4183-8673-6c9559894d98", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payments?page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "payments" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Per-Page", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": []\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-67eea3af-4cb4-4183-8673-6c9559894d98" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-25ebfe89-952f-4933-9af2-fe11fd456f0e" } ], "id": "6fff6365-eb4a-45f5-8f6c-b97f12f747b0", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-6fff6365-eb4a-45f5-8f6c-b97f12f747b0" }, { "name": "payouts", "item": [ { "name": "{ref}", "item": [ { "name": "Void a Payment", "id": "9fcf3bda-e777-435b-84e7-624cbcbf83e7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" } ], "url": { "raw": "{{baseUrl}}/payouts/:ref", "host": [ "{{baseUrl}}" ], "path": [ "payouts", ":ref" ], "variable": [ { "id": "ca88727c-d05c-4bb0-9a6a-8b478e80f353", "key": "ref", "value": "", "description": "(Required) Payment debit reference number e.g D.48" } ] }, "description": "You can void any Payment from your account that has not yet matured.\n" }, "response": [ { "id": "e348b3b4-4601-4230-bce6-a619672854b1", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payouts/:ref", "host": [ "{{baseUrl}}" ], "path": [ "payouts", ":ref" ], "variable": [ { "key": "ref" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-e348b3b4-4601-4230-bce6-a619672854b1" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-9fcf3bda-e777-435b-84e7-624cbcbf83e7" } ], "id": "1317aa80-dc10-421e-b144-972eb47e7397", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-1317aa80-dc10-421e-b144-972eb47e7397" } ], "id": "03bb0057-1aa6-4538-8ecd-192679e16173", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-03bb0057-1aa6-4538-8ecd-192679e16173" }, { "name": "payment_requests", "item": [ { "name": "{payment_request_ref}", "item": [ { "name": "Get a Payment Request", "id": "6767fb2e-5303-465e-bbc6-485210771d71", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_requests/:payment_request_ref", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", ":payment_request_ref" ], "variable": [ { "id": "0e74c074-d1bd-4f05-a42a-dc76f9ac7d68", "key": "payment_request_ref", "value": "", "description": "(Required) Single value, exact match" } ] } }, "response": [ { "id": "ae3bb8db-f6ad-48d5-871f-486d51d154ab", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_requests/:payment_request_ref", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", ":payment_request_ref" ], "variable": [ { "key": "payment_request_ref" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"ref\": \"\",\n \"initiator_id\": \"\",\n \"your_bank_account_id\": \"\",\n \"authoriser_id\": \"\",\n \"authoriser_contact_id\": \"\",\n \"schedule_ref\": \"\",\n \"status\": \"approved\",\n \"status_reason\": \"The nominated bank account for this Payment Request has insufficient funds.\",\n \"matures_at\": \"\",\n \"responded_at\": \"\",\n \"created_at\": \"\",\n \"payout\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"matures_at\": \"\"\n },\n \"credit_ref\": \"\",\n \"metadata\": {}\n }\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-ae3bb8db-f6ad-48d5-871f-486d51d154ab" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-6767fb2e-5303-465e-bbc6-485210771d71" }, { "name": "Cancel a Payment Request", "id": "4d69c0c9-6892-48fd-a7e6-b3ac908d605e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" } ], "url": { "raw": "{{baseUrl}}/payment_requests/:payment_request_ref", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", ":payment_request_ref" ], "variable": [ { "id": "87a2ec59-1eb0-4e47-9b07-b87cc0063014", "key": "payment_request_ref", "value": "", "description": "(Required) Single value, exact match" } ] }, "description": "A Payment Request can be cancelled as long as the associated transaction's state is maturing or matured." }, "response": [ { "id": "f7867a85-959c-4089-99dd-7da07f7cfa86", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_requests/:payment_request_ref", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", ":payment_request_ref" ], "variable": [ { "key": "payment_request_ref" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-f7867a85-959c-4089-99dd-7da07f7cfa86" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-4d69c0c9-6892-48fd-a7e6-b3ac908d605e" } ], "id": "ef044e77-d9e6-4257-8c7d-22dd34e65514", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-ef044e77-d9e6-4257-8c7d-22dd34e65514" }, { "name": "collections", "item": [ { "name": "List Collections", "id": "0447842c-31d5-4bf8-a82d-308e3b2c7b16", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_requests/collections?page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", "collections" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" } ] }, "description": "Payment Requests where you are the creditor and are collecting funds from your debtor using traditional direct-debit." }, "response": [ { "id": "00b80507-f319-48d3-9cda-7cc4770a378d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_requests/collections?page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", "collections" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Per-Page", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"ref\": \"\",\n \"initiator_id\": \"\",\n \"your_bank_account_id\": \"\",\n \"authoriser_id\": \"\",\n \"authoriser_contact_id\": \"\",\n \"contact_initiated\": \"\",\n \"schedule_ref\": \"\",\n \"status\": \"approved\",\n \"status_reason\": null,\n \"matures_at\": \"\",\n \"responded_at\": \"\",\n \"created_at\": \"\",\n \"credit_ref\": \"\",\n \"payout\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"matures_at\": \"\"\n }\n },\n {\n \"ref\": \"\",\n \"initiator_id\": \"\",\n \"your_bank_account_id\": \"\",\n \"authoriser_id\": \"\",\n \"authoriser_contact_id\": \"\",\n \"contact_initiated\": \"\",\n \"schedule_ref\": \"\",\n \"status\": \"cancelled\",\n \"status_reason\": null,\n \"matures_at\": \"\",\n \"responded_at\": \"\",\n \"created_at\": \"\",\n \"credit_ref\": \"\",\n \"payout\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"matures_at\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-00b80507-f319-48d3-9cda-7cc4770a378d" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-0447842c-31d5-4bf8-a82d-308e3b2c7b16" } ], "id": "3d1ccaab-54f9-428c-94a3-e4c9413da62e", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-3d1ccaab-54f9-428c-94a3-e4c9413da62e" }, { "name": "receivables", "item": [ { "name": "List Receivables", "id": "fc8f87c0-634f-47e6-b7ec-2fba536a6339", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_requests/receivables?page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", "receivables" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" } ] }, "description": "Payment Requests where the debtor is sending you funds ([Receivable Contacts](https://docs.zeptopayments.com/reference/addareceivablecontact)). This endpoint exposes all received payments." }, "response": [ { "id": "13d775c2-61b8-40c1-b4fb-02b688b50ab3", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/payment_requests/receivables?page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", "receivables" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Per-Page", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"ref\": \"\",\n \"initiator_id\": \"\",\n \"your_bank_account_id\": \"\",\n \"authoriser_id\": \"\",\n \"authoriser_contact_id\": \"\",\n \"contact_initiated\": \"\",\n \"schedule_ref\": \"\",\n \"status\": \"\",\n \"status_reason\": \"\",\n \"matures_at\": \"\",\n \"responded_at\": \"\",\n \"created_at\": \"\",\n \"credit_ref\": \"\",\n \"payout\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"matures_at\": \"\"\n }\n },\n {\n \"ref\": \"\",\n \"initiator_id\": \"\",\n \"your_bank_account_id\": \"\",\n \"authoriser_id\": \"\",\n \"authoriser_contact_id\": \"\",\n \"contact_initiated\": \"\",\n \"schedule_ref\": \"\",\n \"status\": \"\",\n \"status_reason\": \"\",\n \"matures_at\": \"\",\n \"responded_at\": \"\",\n \"created_at\": \"\",\n \"credit_ref\": \"\",\n \"payout\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"matures_at\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-13d775c2-61b8-40c1-b4fb-02b688b50ab3" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-fc8f87c0-634f-47e6-b7ec-2fba536a6339" } ], "id": "524fffda-a34c-49c5-873e-c9cb58dfb10b", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-524fffda-a34c-49c5-873e-c9cb58dfb10b" }, { "name": "Request Payment", "id": "93c8b7c3-86d2-49fb-ab05-c3ef812ae22e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Idempotency key to support safe retries for 24h", "key": "Idempotency-Key", "value": "" }, { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"authoriser_contact_id\": \"\",\n \"description\": \"\",\n \"matures_at\": \"\",\n \"amount\": \"\",\n \"your_bank_account_id\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_requests", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests" ] }, "description": "\n" }, "response": [ { "id": "ee8dbe31-78cf-4b5c-bbd2-3e18fb1ce607", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Idempotency key to support safe retries for 24h", "key": "Idempotency-Key", "value": "" }, { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "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 \"authoriser_contact_id\": \"\",\n \"description\": \"\",\n \"matures_at\": \"\",\n \"amount\": \"\",\n \"your_bank_account_id\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_requests", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"ref\": \"\",\n \"initiator_id\": \"\",\n \"your_bank_account_id\": \"\",\n \"authoriser_id\": \"\",\n \"authoriser_contact_id\": \"\",\n \"contact_initiated\": \"\",\n \"schedule_ref\": \"\",\n \"status\": \"cancelled\",\n \"status_reason\": null,\n \"matures_at\": \"\",\n \"responded_at\": \"\",\n \"created_at\": \"\",\n \"credit_ref\": \"\",\n \"payout\": {\n \"amount\": \"\",\n \"description\": \"\",\n \"matures_at\": \"\"\n },\n \"metadata\": {}\n }\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-ee8dbe31-78cf-4b5c-bbd2-3e18fb1ce607" }, { "id": "5d3e303b-4197-4ecc-a127-c2dcf0b6a49a", "name": "When a payment is requested from an Anyone Contact with no valid Agreement", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Idempotency key to support safe retries for 24h", "key": "Idempotency-Key", "value": "" }, { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "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 \"authoriser_contact_id\": \"\",\n \"description\": \"\",\n \"matures_at\": \"\",\n \"amount\": \"\",\n \"your_bank_account_id\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/payment_requests", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests" ] } }, "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}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-5d3e303b-4197-4ecc-a127-c2dcf0b6a49a" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-93c8b7c3-86d2-49fb-ab05-c3ef812ae22e" } ], "id": "6ae4e679-3eb7-438f-858d-72b550f66422", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-6ae4e679-3eb7-438f-858d-72b550f66422" }, { "name": "credits", "item": [ { "name": "{credit_ref}", "item": [ { "name": "refunds", "item": [ { "name": "Issue a Refund", "id": "a6273cb4-59ec-4b73-92c2-b605e53f8e85", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Idempotency key to support safe retries for 24h", "key": "Idempotency-Key", "value": "" }, { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"channels\": \"\",\n \"reason\": \"$BrqRt5@~\",\n \"your_bank_account_id\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/credits/:credit_ref/refunds", "host": [ "{{baseUrl}}" ], "path": [ "credits", ":credit_ref", "refunds" ], "variable": [ { "id": "a92e6394-9e79-48e8-bfb6-918941c85e68", "key": "credit_ref", "value": "", "description": "(Required) The credit reference number e.g C.625v" } ] }, "description": "Certain rules apply to the issuance of a refund:\n
    \n
  • Must be applied against a successfully cleared Payment Request (Collections or Receivables)
    • \n
  • Many refunds may be created against the original Payment Request
    • \n
  • The total refunded amount must not exceed the original value
    • \n
\n\n" }, "response": [ { "id": "bcc20820-9240-4c0f-8d34-0ee7b136a5e9", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Idempotency key to support safe retries for 24h", "key": "Idempotency-Key", "value": "" }, { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "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 \"channels\": \"\",\n \"reason\": \"$BrqRt5@~\",\n \"your_bank_account_id\": \"\",\n \"metadata\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/credits/:credit_ref/refunds", "host": [ "{{baseUrl}}" ], "path": [ "credits", ":credit_ref", "refunds" ], "variable": [ { "key": "credit_ref" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"ref\": \"\",\n \"for_ref\": \"\",\n \"debit_ref\": \"\",\n \"your_bank_account_id\": \"\",\n \"created_at\": \"\",\n \"amount\": \"\",\n \"reason\": \"\",\n \"channels\": \"\",\n \"contacts\": {\n \"source_contact_id\": \"\",\n \"target_contact_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-bcc20820-9240-4c0f-8d34-0ee7b136a5e9" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-a6273cb4-59ec-4b73-92c2-b605e53f8e85" } ], "id": "f43973a8-71c7-4d6e-92c2-f2edab5ce33b", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-f43973a8-71c7-4d6e-92c2-f2edab5ce33b" } ], "id": "adedf5e5-652a-45df-90d2-0c33cb986b84", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-adedf5e5-652a-45df-90d2-0c33cb986b84" } ], "id": "361bdf1d-6196-4cf7-b56e-346981cbcba2", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-361bdf1d-6196-4cf7-b56e-346981cbcba2" }, { "name": "refunds", "item": [ { "name": "outgoing", "item": [ { "name": "List Refunds", "id": "11d44f4d-fd0d-4b46-9f5c-232ccf64b36d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/refunds/outgoing?page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "refunds", "outgoing" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" } ] } }, "response": [ { "id": "cd2a6070-f6d4-48e6-b039-cfb945449ffd", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/refunds/outgoing?page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "refunds", "outgoing" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Per-Page", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": []\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-cd2a6070-f6d4-48e6-b039-cfb945449ffd" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-11d44f4d-fd0d-4b46-9f5c-232ccf64b36d" } ], "id": "820a7598-bd13-4a2c-8d9e-929fc0d0ef68", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-820a7598-bd13-4a2c-8d9e-929fc0d0ef68" }, { "name": "{refund_ref}", "item": [ { "name": "Retrieve a Refund", "id": "8abdcac6-42ad-435b-bfe0-37ba6e0dafee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/refunds/:refund_ref", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refund_ref" ], "variable": [ { "id": "282eaab7-db79-4d1a-86a3-b0338fc6047d", "key": "refund_ref", "value": "", "description": "(Required) Single value, exact match" } ] }, "description": "Get a single Refund by its reference" }, "response": [ { "id": "a1cb84b9-6e3d-4385-8e5d-03210fa02050", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/refunds/:refund_ref", "host": [ "{{baseUrl}}" ], "path": [ "refunds", ":refund_ref" ], "variable": [ { "key": "refund_ref" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-a1cb84b9-6e3d-4385-8e5d-03210fa02050" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-8abdcac6-42ad-435b-bfe0-37ba6e0dafee" } ], "id": "3ab39cb9-5573-4685-a0b9-704cab429f5a", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-3ab39cb9-5573-4685-a0b9-704cab429f5a" } ], "id": "8a214b8e-c708-4abb-b516-83795c8bcd1a", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-8a214b8e-c708-4abb-b516-83795c8bcd1a" }, { "name": "transactions", "item": [ { "name": "List all transactions", "id": "1215bc88-3d62-4751-b158-0ba79f81c3aa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transactions?page=&per_page=&ref (debit or credit)=&parent_ref=&bank_ref=&both_parties=&status=preprocessing&category=invoice&type=credit&other_party=&other_party_bank_ref=&party_contact_id=&description=&min_amount=&max_amount=&min_created_date=&max_created_date=&min_matured_date=&max_matured_date=&min_cleared_date=&max_cleared_date=&min_status_changed_date=&max_status_changed_date=", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" }, { "description": "Single value, exact match", "key": "ref (debit or credit)", "value": "" }, { "description": "Single value, exact match", "key": "parent_ref", "value": "" }, { "description": "Single value, exact match", "key": "bank_ref", "value": "" }, { "description": "Single value, exact match. Will also list debits & credits applied to the other party", "key": "both_parties", "value": "" }, { "description": "Multiple values, exact match", "key": "status", "value": "preprocessing" }, { "description": "Multiple values, exact match", "key": "category", "value": "invoice" }, { "description": "Multiple values, exact match", "key": "type", "value": "credit" }, { "description": "Single value, string search. Cannot be combine with both_parties query string", "key": "other_party", "value": "" }, { "description": "Single value, exact match", "key": "other_party_bank_ref", "value": "" }, { "description": "Single value, exact match. Cannot be combine with both_parties query string", "key": "party_contact_id", "value": "" }, { "description": "Single value, string search", "key": "description", "value": "" }, { "description": "Cents, single value, exact match", "key": "min_amount", "value": "" }, { "description": "Cents, single value, exact match", "key": "max_amount", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "min_created_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "max_created_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "min_matured_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "max_matured_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "min_cleared_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "max_cleared_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "min_status_changed_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "max_status_changed_date", "value": "" } ] }, "description": "" }, "response": [ { "id": "3027fd18-a97f-41ea-9b38-9816ab75394d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transactions?page=&per_page=&ref (debit or credit)=&parent_ref=&bank_ref=&both_parties=&status=preprocessing&category=invoice&type=credit&other_party=&other_party_bank_ref=&party_contact_id=&description=&min_amount=&max_amount=&min_created_date=&max_created_date=&min_matured_date=&max_matured_date=&min_cleared_date=&max_cleared_date=&min_status_changed_date=&max_status_changed_date=", "host": [ "{{baseUrl}}" ], "path": [ "transactions" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" }, { "description": "Single value, exact match", "key": "ref (debit or credit)", "value": "" }, { "description": "Single value, exact match", "key": "parent_ref", "value": "" }, { "description": "Single value, exact match", "key": "bank_ref", "value": "" }, { "description": "Single value, exact match. Will also list debits & credits applied to the other party", "key": "both_parties", "value": "" }, { "description": "Multiple values, exact match", "key": "status", "value": "preprocessing" }, { "description": "Multiple values, exact match", "key": "category", "value": "invoice" }, { "description": "Multiple values, exact match", "key": "type", "value": "credit" }, { "description": "Single value, string search. Cannot be combine with both_parties query string", "key": "other_party", "value": "" }, { "description": "Single value, exact match", "key": "other_party_bank_ref", "value": "" }, { "description": "Single value, exact match. Cannot be combine with both_parties query string", "key": "party_contact_id", "value": "" }, { "description": "Single value, string search", "key": "description", "value": "" }, { "description": "Cents, single value, exact match", "key": "min_amount", "value": "" }, { "description": "Cents, single value, exact match", "key": "max_amount", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "min_created_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "max_created_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "min_matured_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "max_matured_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "min_cleared_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "max_cleared_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "min_status_changed_date", "value": "" }, { "description": "Date/time UTC ISO 8601 format, single value, exact match", "key": "max_status_changed_date", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Per-Page", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"ref\": \"\",\n \"parent_ref\": \"\",\n \"type\": \"debit\",\n \"category\": \"recovery\",\n \"created_at\": \"\",\n \"cleared_at\": \"\",\n \"bank_ref\": \"\",\n \"status\": \"returned\",\n \"status_changed_at\": \"\",\n \"party_contact_id\": \"\",\n \"party_name\": \"\",\n \"party_nickname\": \"\",\n \"party_bank_ref\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"bank_account_id\": \"\",\n \"channels\": \"\",\n \"current_channel\": \"new_payments_platform\",\n \"matures_at\": \"\",\n \"failure_details\": \"\",\n \"failure\": {\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\"\n },\n \"reversal_details\": {\n \"source_debit_ref\": \"\",\n \"source_credit_failure\": {\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\"\n }\n },\n \"metadata\": {}\n },\n {\n \"ref\": \"\",\n \"parent_ref\": \"\",\n \"type\": \"credit\",\n \"category\": \"transfer\",\n \"created_at\": \"\",\n \"cleared_at\": \"\",\n \"bank_ref\": \"\",\n \"status\": \"channel_switched\",\n \"status_changed_at\": \"\",\n \"party_contact_id\": \"\",\n \"party_name\": \"\",\n \"party_nickname\": \"\",\n \"party_bank_ref\": \"\",\n \"description\": \"\",\n \"amount\": \"\",\n \"bank_account_id\": \"\",\n \"channels\": \"\",\n \"current_channel\": \"direct_entry\",\n \"matures_at\": \"\",\n \"failure_details\": \"\",\n \"failure\": {\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\"\n },\n \"reversal_details\": {\n \"source_debit_ref\": \"\",\n \"source_credit_failure\": {\n \"code\": \"\",\n \"title\": \"\",\n \"detail\": \"\"\n }\n },\n \"metadata\": {}\n }\n ]\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-3027fd18-a97f-41ea-9b38-9816ab75394d" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-1215bc88-3d62-4751-b158-0ba79f81c3aa" } ], "id": "d85f6030-7dd0-4995-8c19-c6b7ebd29cf7", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-d85f6030-7dd0-4995-8c19-c6b7ebd29cf7" }, { "name": "transfers", "item": [ { "name": "{transfer_ref}", "item": [ { "name": "Get a Transfer (Available soon)", "id": "61698e2c-94d6-4867-bc21-103ef9e7c7fc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transfers/:transfer_ref", "host": [ "{{baseUrl}}" ], "path": [ "transfers", ":transfer_ref" ], "variable": [ { "id": "3bfe489e-4872-48e6-aa21-37d6b0d2b579", "key": "transfer_ref", "value": "", "description": "(Required) Transfer reference" } ] }, "description": "Get a single transfer by its reference" }, "response": [ { "id": "a64ad6a5-5c8e-4c0b-923e-b24c14311448", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transfers/:transfer_ref", "host": [ "{{baseUrl}}" ], "path": [ "transfers", ":transfer_ref" ], "variable": [ { "key": "transfer_ref" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"ref\": \"\",\n \"from_bank_account_id\": \"\",\n \"to_bank_account_id\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"matures_at\": \"\",\n \"initiator_id\": \"\"\n }\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-a64ad6a5-5c8e-4c0b-923e-b24c14311448" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-61698e2c-94d6-4867-bc21-103ef9e7c7fc" } ], "id": "e616615f-fd9a-4d10-ba65-0b5c6d79e9ea", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-e616615f-fd9a-4d10-ba65-0b5c6d79e9ea" }, { "name": "Add a Transfer", "id": "a95a9c5c-4ec8-4943-9061-a2bf9c43a449", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Idempotency key to support safe retries for 24h", "key": "Idempotency-Key", "value": "" }, { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"from_bank_account_id\": \"\",\n \"to_bank_account_id\": \"\",\n \"amount\": \"\",\n \"description\": \"QAEeG~\",\n \"matures_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transfers", "host": [ "{{baseUrl}}" ], "path": [ "transfers" ] }, "description": "Use this endpoint when you want to create a Transfer between any 2 of your float/bank accounts.\n\n" }, "response": [ { "id": "4dc736d8-164a-4304-b916-6202e7dc8398", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Idempotency key to support safe retries for 24h", "key": "Idempotency-Key", "value": "" }, { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "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 \"from_bank_account_id\": \"\",\n \"to_bank_account_id\": \"\",\n \"amount\": \"\",\n \"description\": \"QAEeG~\",\n \"matures_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/transfers", "host": [ "{{baseUrl}}" ], "path": [ "transfers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"ref\": \"\",\n \"from_bank_account_id\": \"\",\n \"to_bank_account_id\": \"\",\n \"amount\": \"\",\n \"description\": \"\",\n \"matures_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-4dc736d8-164a-4304-b916-6202e7dc8398" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-a95a9c5c-4ec8-4943-9061-a2bf9c43a449" }, { "name": "List all Transfers (Available soon)", "id": "82d22a36-e269-470e-ae2c-5905c29ab9a3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/transfers?page=&per_page=&from_bank_account_id=&to_bank_account_id=", "host": [ "{{baseUrl}}" ], "path": [ "transfers" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" }, { "description": "Source bank/float account UUID, single value, exact match", "key": "from_bank_account_id", "value": "" }, { "description": "Target bank/float account UUID, single value, exact match", "key": "to_bank_account_id", "value": "" } ] } }, "response": [ { "id": "97c595c0-8104-4337-8d6b-1c3ab7d49730", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/transfers?page=&per_page=&from_bank_account_id=&to_bank_account_id=", "host": [ "{{baseUrl}}" ], "path": [ "transfers" ], "query": [ { "description": "Page of results to return, single value, exact match", "key": "page", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" }, { "description": "Source bank/float account UUID, single value, exact match", "key": "from_bank_account_id", "value": "" }, { "description": "Target bank/float account UUID, single value, exact match", "key": "to_bank_account_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Per-Page", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": []\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-97c595c0-8104-4337-8d6b-1c3ab7d49730" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-82d22a36-e269-470e-ae2c-5905c29ab9a3" } ], "id": "b4daa201-ac0d-464c-9c46-7503485897de", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-b4daa201-ac0d-464c-9c46-7503485897de" }, { "name": "ping", "item": [ { "name": "Ping", "id": "2920a54a-a7fb-4dae-9d77-d006668001e5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/ping", "host": [ "{{baseUrl}}" ], "path": [ "ping" ] }, "description": "A simple endpoint to test your connectivity and authentication." }, "response": [ { "id": "92541e3c-94df-4f00-a2b0-630aadd8a400", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/ping", "host": [ "{{baseUrl}}" ], "path": [ "ping" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"ping\": \"\"\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-92541e3c-94df-4f00-a2b0-630aadd8a400" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-2920a54a-a7fb-4dae-9d77-d006668001e5" } ], "id": "b008e8a7-7a32-4e49-8131-7b45aa28de52", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-b008e8a7-7a32-4e49-8131-7b45aa28de52" }, { "name": "user", "item": [ { "name": "Get user details", "id": "cbd0531c-5864-44ae-a82a-ecc1b3415933", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user", "host": [ "{{baseUrl}}" ], "path": [ "user" ] } }, "response": [ { "id": "6c1085e2-b630-44cd-8022-46f0eb36ae3a", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/user", "host": [ "{{baseUrl}}" ], "path": [ "user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-6c1085e2-b630-44cd-8022-46f0eb36ae3a" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-cbd0531c-5864-44ae-a82a-ecc1b3415933" } ], "id": "095f73e8-01ee-4f46-af02-d2a1a5be7244", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-095f73e8-01ee-4f46-af02-d2a1a5be7244" }, { "name": "webhooks", "item": [ { "name": "{webhook_id}", "item": [ { "name": "deliveries", "item": [ { "name": "List deliveries for a webhook", "id": "0a55e9df-553d-48ca-ae1e-37c3bbcc2cad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhooks/:webhook_id/deliveries?ref=&per_page=&starting_after=&event_type=See ([Data schemas](/%23data-schemas))&since=&response_status_code=2xx&response_status_code=4xx&state=completed&state=failed", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhook_id", "deliveries" ], "query": [ { "description": "Filter deliveries by ref (`WebhookDelivery.data.ref`), single value, exact match", "key": "ref", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" }, { "description": "Display all webhook deliveries after this webhook delivery offset UUID, single value, exact match", "key": "starting_after", "value": "" }, { "description": "See ([Data schemas](/#data-schemas)) for a list of possible values, single value, exact match", "key": "event_type", "value": "See ([Data schemas](/#data-schemas))" }, { "description": "Display all webhook deliveries after this date. Date/time UTC ISO 8601 format, single value, exact match", "key": "since", "value": "" }, { "description": "Single value / multiple values separated by commas", "key": "response_status_code", "value": "2xx" }, { "description": "Single value / multiple values separated by commas", "key": "response_status_code", "value": "4xx" }, { "description": "Filter deliveries by state, single value / multiple values separated by commas. See [Our delivery promise](#our-delivery-promises)", "key": "state", "value": "completed" }, { "description": "Filter deliveries by state, single value / multiple values separated by commas. See [Our delivery promise](#our-delivery-promises)", "key": "state", "value": "failed" } ], "variable": [ { "id": "51df06d2-4796-46b0-a40b-70f66c8e6fcd", "key": "webhook_id", "value": "", "description": "(Required) Single value, exact match" } ] }, "description": "NOTE: Webhook deliveries are stored for 7 days." }, "response": [ { "id": "e9d5e10e-14a5-45a9-9ffc-ae662383f004", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhooks/:webhook_id/deliveries?ref=&per_page=&starting_after=&event_type=See ([Data schemas](/%23data-schemas))&since=&response_status_code=4xx&state=failed", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhook_id", "deliveries" ], "query": [ { "description": "Filter deliveries by ref (`WebhookDelivery.data.ref`), single value, exact match", "key": "ref", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" }, { "description": "Display all webhook deliveries after this webhook delivery offset UUID, single value, exact match", "key": "starting_after", "value": "" }, { "description": "See ([Data schemas](/#data-schemas)) for a list of possible values, single value, exact match", "key": "event_type", "value": "See ([Data schemas](/#data-schemas))" }, { "description": "Display all webhook deliveries after this date. Date/time UTC ISO 8601 format, single value, exact match", "key": "since", "value": "" }, { "description": "Single value / multiple values separated by commas", "key": "response_status_code", "value": "4xx" }, { "description": "Filter deliveries by state, single value / multiple values separated by commas. See [Our delivery promise](#our-delivery-promises)", "key": "state", "value": "failed" } ], "variable": [ { "key": "webhook_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Per-Page", "value": "" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-e9d5e10e-14a5-45a9-9ffc-ae662383f004" }, { "id": "80b61d4c-2d1b-4e9e-be36-cd812bbd41f6", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhooks/:webhook_id/deliveries?ref=&per_page=&starting_after=&event_type=See ([Data schemas](/%23data-schemas))&since=&response_status_code=4xx&state=failed", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":webhook_id", "deliveries" ], "query": [ { "description": "Filter deliveries by ref (`WebhookDelivery.data.ref`), single value, exact match", "key": "ref", "value": "" }, { "description": "Number of results per page, single value, exact match", "key": "per_page", "value": "" }, { "description": "Display all webhook deliveries after this webhook delivery offset UUID, single value, exact match", "key": "starting_after", "value": "" }, { "description": "See ([Data schemas](/#data-schemas)) for a list of possible values, single value, exact match", "key": "event_type", "value": "See ([Data schemas](/#data-schemas))" }, { "description": "Display all webhook deliveries after this date. Date/time UTC ISO 8601 format, single value, exact match", "key": "since", "value": "" }, { "description": "Single value / multiple values separated by commas", "key": "response_status_code", "value": "4xx" }, { "description": "Filter deliveries by state, single value / multiple values separated by commas. See [Our delivery promise](#our-delivery-promises)", "key": "state", "value": "failed" } ], "variable": [ { "key": "webhook_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-80b61d4c-2d1b-4e9e-be36-cd812bbd41f6" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-0a55e9df-553d-48ca-ae1e-37c3bbcc2cad" } ], "id": "68cdb2f6-ec9e-4451-832f-d14f926be367", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-68cdb2f6-ec9e-4451-832f-d14f926be367" } ], "id": "3e6ef065-fe77-4898-8603-262654bdf1ea", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-3e6ef065-fe77-4898-8603-262654bdf1ea" }, { "name": "List all webhooks", "id": "a8fc88d1-1fb5-4543-868e-f491326eda5b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] }, "description": "List all your application's webhook configurations." }, "response": [ { "id": "5d691b39-52ba-4817-bcd3-4ff5259378a3", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Per-Page", "value": "" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": []\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-5d691b39-52ba-4817-bcd3-4ff5259378a3" }, { "id": "04e59970-21e3-4d1b-b7ae-f5c558351166", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-04e59970-21e3-4d1b-b7ae-f5c558351166" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-a8fc88d1-1fb5-4543-868e-f491326eda5b" } ], "id": "b21c39c8-ac94-4f30-9ed8-bcd34838a20b", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-b21c39c8-ac94-4f30-9ed8-bcd34838a20b" }, { "name": "webhook_deliveries", "item": [ { "name": "{id}", "item": [ { "name": "redeliver", "item": [ { "name": "Resend a Webhook Delivery", "id": "a9e1a417-69ec-4417-8eea-0bf97e60dcdc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhook_deliveries/:id/redeliver", "host": [ "{{baseUrl}}" ], "path": [ "webhook_deliveries", ":id", "redeliver" ], "variable": [ { "id": "4bd34e27-6651-45ce-82c8-5d4590b4e5e9", "key": "id", "value": "", "description": "(Required) WebhookDelivery ID (`WebhookDelivery.data.id`)" } ] }, "description": "Use this endpoint to resend a failed webhook delivery.\n" }, "response": [ { "id": "e7d0c8e9-e9f4-484a-9e22-e16d3edcb067", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhook_deliveries/:id/redeliver", "host": [ "{{baseUrl}}" ], "path": [ "webhook_deliveries", ":id", "redeliver" ], "variable": [ { "key": "id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {}\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-e7d0c8e9-e9f4-484a-9e22-e16d3edcb067" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-a9e1a417-69ec-4417-8eea-0bf97e60dcdc" } ], "id": "2d293700-3259-4c2e-9393-3524c84fddc5", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-2d293700-3259-4c2e-9393-3524c84fddc5" }, { "name": "Get a Webhook Delivery", "id": "30560add-e5e8-4fef-942e-f066cc826bd3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhook_deliveries/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhook_deliveries", ":id" ], "variable": [ { "id": "730f9cf4-6774-4bd6-ac99-84e752582f0e", "key": "id", "value": "", "description": "(Required) WebhookDelivery ID (`WebhookDelivery.data.id`)" } ] }, "description": "Get a single webhook delivery by ID." }, "response": [ { "id": "484fa286-cea3-44a8-9d9f-70183aa90ac4", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhook_deliveries/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhook_deliveries", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"webhook_id\": \"\",\n \"state\": \"pending\",\n \"payload\": {},\n \"created_at\": \"\"\n }\n}", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-484fa286-cea3-44a8-9d9f-70183aa90ac4" }, { "id": "988c3916-26fe-40cf-b99e-7369f21e213e", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/webhook_deliveries/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhook_deliveries", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-988c3916-26fe-40cf-b99e-7369f21e213e" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-30560add-e5e8-4fef-942e-f066cc826bd3" } ], "id": "be13fb72-d978-495f-945e-c9bf22da6e9e", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-be13fb72-d978-495f-945e-c9bf22da6e9e" } ], "id": "efc6bb76-98e8-46e9-b5bd-44f734da2254", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-efc6bb76-98e8-46e9-b5bd-44f734da2254" }, { "name": "simulate", "item": [ { "name": "incoming_npp_payid_payment", "item": [ { "name": "Simulate incoming PayID payment", "id": "9c29bc2e-797f-4dba-8141-20aae778c8e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payid_email\": \"\",\n \"amount\": \"\",\n \"payment_description\": \"\",\n \"payment_reference\": \"\",\n \"from_bsb\": \"\",\n \"from_account_number\": \"\",\n \"debtor_name\": \"4@@$M\",\n \"debtor_legal_name\": \"R@4Cl8^pUw\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/simulate/incoming_npp_payid_payment", "host": [ "{{baseUrl}}" ], "path": [ "simulate", "incoming_npp_payid_payment" ] }, "description": "Simulate receiving a real-time PayID payment from one of your Receivable Contacts." }, "response": [ { "id": "dea8e4ff-de76-4de1-ac9e-73be192b8f2d", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"payid_email\": \"\",\n \"amount\": \"\",\n \"payment_description\": \"\",\n \"payment_reference\": \"\",\n \"from_bsb\": \"\",\n \"from_account_number\": \"\",\n \"debtor_name\": \"4@@$M\",\n \"debtor_legal_name\": \"R@4Cl8^pUw\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/simulate/incoming_npp_payid_payment", "host": [ "{{baseUrl}}" ], "path": [ "simulate", "incoming_npp_payid_payment" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-dea8e4ff-de76-4de1-ac9e-73be192b8f2d" }, { "id": "adf36e70-5ac6-4b31-83f5-e8633905d3c0", "name": "Invalid parameters", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"payid_email\": \"\",\n \"amount\": \"\",\n \"payment_description\": \"\",\n \"payment_reference\": \"\",\n \"from_bsb\": \"\",\n \"from_account_number\": \"\",\n \"debtor_name\": \"4@@$M\",\n \"debtor_legal_name\": \"R@4Cl8^pUw\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/simulate/incoming_npp_payid_payment", "host": [ "{{baseUrl}}" ], "path": [ "simulate", "incoming_npp_payid_payment" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-adf36e70-5ac6-4b31-83f5-e8633905d3c0" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-9c29bc2e-797f-4dba-8141-20aae778c8e9" } ], "id": "b7928f35-21ec-45c0-93a2-abf388f7d1bb", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-b7928f35-21ec-45c0-93a2-abf388f7d1bb" }, { "name": "incoming_npp_bban_payment", "item": [ { "name": "Simulate an incoming real-time payment", "id": "9e4bea5c-dafb-48a0-a398-88d35d7af19b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"to_bsb\": \"\",\n \"to_account_number\": \"\",\n \"amount\": \"\",\n \"payment_description\": \"\",\n \"payment_reference\": \"\",\n \"from_bsb\": \"\",\n \"from_account_number\": \"\",\n \"debtor_name\": \"V!lgyC%Y9/\",\n \"debtor_legal_name\": \"c$&~\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/simulate/incoming_npp_bban_payment", "host": [ "{{baseUrl}}" ], "path": [ "simulate", "incoming_npp_bban_payment" ] }, "description": "Simulate receiving a real-time payment to either a Receivable Contact or one of your float accounts, made using a BSB and account number (i.e. not via PayID).\n" }, "response": [ { "id": "40f8c7fd-3f76-4e14-8190-16ce2034f229", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"to_bsb\": \"\",\n \"to_account_number\": \"\",\n \"amount\": \"\",\n \"payment_description\": \"\",\n \"payment_reference\": \"\",\n \"from_bsb\": \"\",\n \"from_account_number\": \"\",\n \"debtor_name\": \"V!lgyC%Y9/\",\n \"debtor_legal_name\": \"c$&~\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/simulate/incoming_npp_bban_payment", "host": [ "{{baseUrl}}" ], "path": [ "simulate", "incoming_npp_bban_payment" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-40f8c7fd-3f76-4e14-8190-16ce2034f229" }, { "id": "faf3aeeb-90c4-4e3d-b450-6d0125d43267", "name": "Invalid parameters", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"to_bsb\": \"\",\n \"to_account_number\": \"\",\n \"amount\": \"\",\n \"payment_description\": \"\",\n \"payment_reference\": \"\",\n \"from_bsb\": \"\",\n \"from_account_number\": \"\",\n \"debtor_name\": \"V!lgyC%Y9/\",\n \"debtor_legal_name\": \"c$&~\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/simulate/incoming_npp_bban_payment", "host": [ "{{baseUrl}}" ], "path": [ "simulate", "incoming_npp_bban_payment" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-faf3aeeb-90c4-4e3d-b450-6d0125d43267" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-9e4bea5c-dafb-48a0-a398-88d35d7af19b" } ], "id": "7150f34e-b823-4d2b-9f2c-154b97f6fa30", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-7150f34e-b823-4d2b-9f2c-154b97f6fa30" }, { "name": "incoming_de_payment", "item": [ { "name": "Simulate an incoming DE payment", "id": "32e37caf-b2f8-4ad0-b779-a33d01a1e62a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"to_bsb\": \"\",\n \"to_account_number\": \"\",\n \"amount\": \"\",\n \"payment_reference\": \"\",\n \"from_bsb\": \"\",\n \"from_account_number\": \"\",\n \"debtor_name\": \"*ui\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/simulate/incoming_de_payment", "host": [ "{{baseUrl}}" ], "path": [ "simulate", "incoming_de_payment" ] }, "description": "Simulate receiving a Direct Entry payment (i.e. not a real-time payment) to either a Receivable Contact or one of your float accounts.\n" }, "response": [ { "id": "6fd5199d-70b4-496f-b687-ed2a07715822", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"to_bsb\": \"\",\n \"to_account_number\": \"\",\n \"amount\": \"\",\n \"payment_reference\": \"\",\n \"from_bsb\": \"\",\n \"from_account_number\": \"\",\n \"debtor_name\": \"*ui\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/simulate/incoming_de_payment", "host": [ "{{baseUrl}}" ], "path": [ "simulate", "incoming_de_payment" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-6fd5199d-70b4-496f-b687-ed2a07715822" }, { "id": "e03c930f-4202-478a-b335-da817acb4c22", "name": "Invalid parameters", "originalRequest": { "method": "POST", "header": [ { "description": "API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.", "key": "Zepto-API-Version", "value": "20250101" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"to_bsb\": \"\",\n \"to_account_number\": \"\",\n \"amount\": \"\",\n \"payment_reference\": \"\",\n \"from_bsb\": \"\",\n \"from_account_number\": \"\",\n \"debtor_name\": \"*ui\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/simulate/incoming_de_payment", "host": [ "{{baseUrl}}" ], "path": [ "simulate", "incoming_de_payment" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-e03c930f-4202-478a-b335-da817acb4c22" } ], "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-32e37caf-b2f8-4ad0-b779-a33d01a1e62a" } ], "id": "7d9e7e65-b395-49af-aca9-43ab7d1d3f5c", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-7d9e7e65-b395-49af-aca9-43ab7d1d3f5c" } ], "id": "1500c0e7-13d5-4663-b831-8a838a6daeff", "createdAt": "2026-07-28T03:37:23.000Z", "updatedAt": "2026-07-28T03:37:23.000Z", "uid": "35240-1500c0e7-13d5-4663-b831-8a838a6daeff" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "public contacts payments payment_requests refunds agreements transactions open_agreements transfers", "type": "string" }, { "key": "redirect_uri", "value": "/oauth/token", "type": "string" }, { "key": "accessTokenUrl", "value": "/oauth/token", "type": "string" }, { "key": "authUrl", "value": "/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.sandbox.zeptopayments.com" } ] }