{ "info": { "_postman_id": "5fc2871d-a062-4f62-a0dd-bed8739c7650", "name": "PayTo", "description": "\u201cPayTo\u201d is a new digital payments service that allows NPP-enabled account holders to digitally pre-authorise one-off or recurring real-time payments from their bank account. This swagger document lists APIs for PayTo agreement creation, management and payment initiation. \n\n**Changes in 1.4 version**\n\n\n\nEnriching timestamp fields to include microseconds information - \u201dcreated_at\u201d and \u201dupdated_at\u201d fields returned via our API & web hook notifications (agreement and payto payments payloads) will include microseconds in the timestamp. \n\nRevised timestamp format example - 2023-08-10 09:03:16.045622 \n\nError code updates - \n\n **Validate PayTo Agreement API:** \n- Added new error codes - PAYT-ERR-2029, PAYT-ERR-2030, PAYT-ERR-2031 \n- Removed error codes - PAYT-ERR-2026, PAYT-ERR-2024 \n\n **Amend PayTo Agreement Details API:** \n- Added new error codes - PAYT-ERR-2321, PAYT-ERR-2322 \n- Removed error codes - PAYT-ERR-2310, PAYT-ERR-2312 \n\n **Initiate PayTo Payment API:** \n- Added new error code - PAYT-ERR-2526\n\n\n**Changes in 1.3 version**\n\n\n**Payment Amount Validations:** \n\nZai will perform additional payment request compliance checks. This is to help minimise non-compliant payment requests. It is essential to continue to ensure PayTo payment requests are made according to the specified amounts, day/time, frequency, and with all other terms specified in the PayTo Agreement. \n\nPayment amount-related verifications will be performed for: \n- Usage and Variable Agreements: the payment requested must be within the maximum amount field and the amount field (which acts as the minimum amount field) i.e., if the agreement amount is between $50 and $75, the payment instruction amount must be within this range. \n\n Note - Consider specifying a maximum and minimum value amount, as the payment amount can differ each time. These limits may provide clarity for the end-customer and may minimise the probability of them receiving a warning message from their bank. \n- Fixed Agreements: payments initiated must match the agreed amount; i.e., if the agreement amount is $50, the payment instruction amount must also be $50 \n- Balloon Agreements: the fixed and final payment amounts will be checked. The final amount must be equal to or greater than the fixed amount. If it\u2019s not, the payment request will be rejected. i.e., the agreement amount is $1,200 over 10 payments (9 fixed and 1 final payments) the fixed amount could be $100, and the final amount $300. \n\nRelevant error messages have also been added as part of this release around rejecting payments that are not compliant as per amount specified in the agreement.\n\n\n**Changes in 1.2 version**\n\n\n **New APIs:** \n- Get all PayTo Agreements for a user - This API lists all PayTo agreements associated with a particular user. If needed, the results can be filtered to list agreements for a particular status or for a particular type (AUPM/MGCR). \n- Get all PayTo Payment Initiation Requests for an agreement - This API lists all payment requests initiated for an agreement. If needed, the results can be filtered to list requests for a particular status. \n- Recall PayTo Agreement - If a custom expiry duration (anything less than 5 days) has been specified for an agreement creation/amendment request and if the debtor has not responded within the specified timeframe, this API should be used to recall such pending authorisation requests. Post successful recall, the request is considered cancelled and hence cannot be actioned by the debtor. \n\n Note - Agreement creation or Bilateral agreement amendments trigger authorisation requests waiting approval from debtor, which can be recalled via this API, if needed.\n\n **Validate PayTo Agreement API:** \n- New Optional Field: response_requested_by -> This field should be used to specify a custom expiry duration i.e. if the debtor authorisation request needs to be limited to any short duration which is less than the default duration of 5 days. \n- Updated Field Description: agreement_info.debtor_info.debtor_details.debtor_reference -> If end to end Id is not provided in the payment initiation request, then the debtor reference (if provided) in the agreement will be used as end to end identifier for the payments initiated via the agreement.\n\n **Initiate PayTo Payment API:** \n- Updated Field Description: payment_info.end_to_end_id -> If end to end Id is not provided in the payment initiation request, then the debtor reference (if provided) in the agreement will be used as end to end identifier for the payments initiated via the agreement. If debtor reference is also not available, default value \u201cNOTPROVIDED\u201d will set as end to end id for the payment initiation request.\n\n\n**Changes in 1.1 version**\n\n\n **Validate PayTo Agreement API:** \n- Support open ended agreements - For Adhoc frequency, providing point_in_time or count_per_period info is optional. \n- Reformatting debtor account number - During the agreement validation step, Zai may reformat the debtor account number as per the format expected by the payer institutions. Reformatted debtor account number can be accessed either via GET PayTo Agreement Details API after the validation step or via WAPI notification sent by Zai after successful agreement creation step.\n\n **Amend PayTo Agreement Details API:** \n- Ability to clear optional fields if needed using hyphen (-) character.\n\n **Amend PayTo Agreement Status API:** \n- Allow agreement status amendments even if a bilateral amendment is in progress. Example - If agreement details amendment is in progress, it should be possible to pause/suspend the agreement if needed.\n\n **Get PayTo Agreement Details API:** \n- New fields - Status reason code and Status reason description have been added in response. These fields will provide more details for suspended or cancelled agreements.\n\n **Get PayTo Payment Details API:** \n- New fields - Status reason code and Status reason description have been added in response. These fields will provide more details for rejected payments.\n\n **Misc:** \n- Agreement purpose codes have been elaborated to clarify the usage for each type. \n- Status descriptions returned in the GET APIs have been improved to provide more details about the current agreement status. \n- PAYT-ERR-2201, PAYT-ERR-2301 - error descriptions have been updated. \n- PAYT-ERR-2318 - added new error code along with description.\n\n\nContact Support:\n Name: Zai\n Email: support@hellozai.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "lastUpdatedBy": "35240", "uid": "35240-5fc2871d-a062-4f62-a0dd-bed8739c7650" }, "item": [ { "name": "agreements", "item": [ { "name": "{agreement_uuid}", "item": [ { "name": "payment_requests", "item": [ { "name": "initiate", "item": [ { "name": "Initiate PayTo Payment", "id": "79df176f-5830-473f-a0b6-bed43b2f7cc6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"payment_info\": {\n \"instructed_amount\": \"75290928\",\n \"last_payment\": false,\n \"end_to_end_id\": \"KgijobAR2bj6d2Hw\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n },\n \"priority\": \"UNATTENDED\",\n \"retry_info\": {\n \"payment_request_uuid\": \"KHrauUZt9ed-De9XGu0fJrntceXSEVGYK8bP\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests/initiate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests", "initiate" ], "variable": [ { "id": "db092b5b-9a9c-4b21-b811-db8a2e2b2842", "key": "agreement_uuid", "value": "", "description": "(Required) " } ] }, "description": "This endpoint is to initiate a payment to collect funds from the debtor's account or to retry if the previous payment collection request was rejected due to valid business reasons.\nThis API should be invoked strictly as per the terms and conditions established in the agreement to avoid payment claims. Even the retries should be attempted as per the agreement terms and conditions.\n\n Payment initiation request statuses -\n- PENDING_PAYMENT_INITIATION - when the payment initiation request has been accepted for processing \n- PAYMENT_INITIATED - when the payment initiation request is being processed \n- PAYMENT_INITIATION_COMPLETED - when the payment initiation request is cleared and settled successfully. Funds can be expected in the user's wallet soon \n- PAYMENT_INITIATION_REJECTED - when the payment initiation request is rejected for processing due to validation, funds not available in the debtor's account or any other \nbusiness reason. A retry can be performed in such scenarios \n\nIf the payment collection request has been rejected due to valid business reasons (example - insufficient funds), a retry can be attempted for the same.\n\nPayment_request_uuid generated will be the same for the payment collection request and all subsequent retry attempts, however, instruction_id differs for each.\n\nNote - If Payment initiated on the agreement validity end date fails, it will not be possible to retry or initiate again on the following date as the agreement will be marked as CANCELLED automatically after the agreement validity_end_date. Hence, it is recommended to initiate the last payment few days before the agreement validity end date to cater for retries needed if any." }, "response": [ { "id": "162529f5-5f05-40ef-9829-87538f24dc69", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"payment_info\": {\n \"instructed_amount\": \"75290928\",\n \"last_payment\": false,\n \"end_to_end_id\": \"KgijobAR2bj6d2Hw\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n },\n \"priority\": \"UNATTENDED\",\n \"retry_info\": {\n \"payment_request_uuid\": \"KHrauUZt9ed-De9XGu0fJrntceXSEVGYK8bP\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests/initiate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests", "initiate" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_request_uuid\": \"\",\n \"agreement_uuid\": \"\",\n \"instruction_id\": \"\",\n \"status\": \"PENDING_PAYMENT_INITIATION\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"agreement_id\": \"\"\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-162529f5-5f05-40ef-9829-87538f24dc69" }, { "id": "df9bcbe8-4eaf-43f8-9192-47296160e42c", "name": "Bad Request \n \n
Error CodeError Message
PAYT-ERR-1050Mandatory info missing: [FieldName] cannot be null or empty.
PAYT-ERR-1051Invalid Data: [FieldName] provided is ", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"payment_info\": {\n \"instructed_amount\": \"75290928\",\n \"last_payment\": false,\n \"end_to_end_id\": \"KgijobAR2bj6d2Hw\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n },\n \"priority\": \"UNATTENDED\",\n \"retry_info\": {\n \"payment_request_uuid\": \"KHrauUZt9ed-De9XGu0fJrntceXSEVGYK8bP\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests/initiate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests", "initiate" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-df9bcbe8-4eaf-43f8-9192-47296160e42c" }, { "id": "25c93566-8843-417e-b6ed-cfc48d14c8b5", "name": "Unauthorised \n
Error CodeError Message
PAYT-ERR-1000Invalid or missing authorisation token.
", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"payment_info\": {\n \"instructed_amount\": \"75290928\",\n \"last_payment\": false,\n \"end_to_end_id\": \"KgijobAR2bj6d2Hw\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n },\n \"priority\": \"UNATTENDED\",\n \"retry_info\": {\n \"payment_request_uuid\": \"KHrauUZt9ed-De9XGu0fJrntceXSEVGYK8bP\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests/initiate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests", "initiate" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-25c93566-8843-417e-b6ed-cfc48d14c8b5" }, { "id": "7085aaff-a392-4734-8e3c-19566d0585cd", "name": "Forbidden \n" } ], "body": { "mode": "raw", "raw": "{\n \"payment_info\": {\n \"instructed_amount\": \"75290928\",\n \"last_payment\": false,\n \"end_to_end_id\": \"KgijobAR2bj6d2Hw\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n },\n \"priority\": \"UNATTENDED\",\n \"retry_info\": {\n \"payment_request_uuid\": \"KHrauUZt9ed-De9XGu0fJrntceXSEVGYK8bP\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests/initiate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests", "initiate" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-7085aaff-a392-4734-8e3c-19566d0585cd" }, { "id": "06da85bc-a041-4cea-9df2-7ef785e9c480", "name": "Not Found \n
Error CodeError Message
PAYT-ERR-1001PayTo feature not available.
PAYT-ERR-1002Request rejected: User associated with the agreement is not active.
" } ], "body": { "mode": "raw", "raw": "{\n \"payment_info\": {\n \"instructed_amount\": \"75290928\",\n \"last_payment\": false,\n \"end_to_end_id\": \"KgijobAR2bj6d2Hw\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n },\n \"priority\": \"UNATTENDED\",\n \"retry_info\": {\n \"payment_request_uuid\": \"KHrauUZt9ed-De9XGu0fJrntceXSEVGYK8bP\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests/initiate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests", "initiate" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-06da85bc-a041-4cea-9df2-7ef785e9c480" }, { "id": "148d7137-a52a-438e-990c-4f69fb41bafc", "name": "Conflict \n
Error CodeError Message
PAYT-ERR-2500Agreement with provided uuid does not exist.
PAYT-ERR-2511Payment request with provided uuid does not exist.
Error CodeError Message
PAYT-ERR-2516A payment is already in progress for the agreement. Please try again if the current payment request is unsuccessful.
PAYT-ERR-2", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"payment_info\": {\n \"instructed_amount\": \"75290928\",\n \"last_payment\": false,\n \"end_to_end_id\": \"KgijobAR2bj6d2Hw\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n },\n \"priority\": \"UNATTENDED\",\n \"retry_info\": {\n \"payment_request_uuid\": \"KHrauUZt9ed-De9XGu0fJrntceXSEVGYK8bP\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests/initiate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests", "initiate" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-148d7137-a52a-438e-990c-4f69fb41bafc" }, { "id": "533167a2-063d-429f-b0bf-a41304201b6f", "name": "Internal Server Error \n
Error CodeError Message
PAYT-ERR-1003An error occurred processing your request. Please try again.
", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"payment_info\": {\n \"instructed_amount\": \"75290928\",\n \"last_payment\": false,\n \"end_to_end_id\": \"KgijobAR2bj6d2Hw\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n },\n \"priority\": \"UNATTENDED\",\n \"retry_info\": {\n \"payment_request_uuid\": \"KHrauUZt9ed-De9XGu0fJrntceXSEVGYK8bP\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests/initiate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests", "initiate" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-533167a2-063d-429f-b0bf-a41304201b6f" } ], "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-79df176f-5830-473f-a0b6-bed43b2f7cc6" } ], "id": "2815563d-ead8-4a25-9aca-f78975d642ed", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-2815563d-ead8-4a25-9aca-f78975d642ed" }, { "name": "Get All PayTo Payment Initiation Requests for an Agreement", "id": "694ec675-e61b-48d7-ba39-bd6ac7bff4cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests?start_date=&end_date=&status=PAYMENT_INITIATION_REJECTED&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests" ], "query": [ { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "status", "value": "PAYMENT_INITIATION_REJECTED" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ], "variable": [ { "id": "caf24620-6384-4d5e-9f36-9b2246594d97", "key": "agreement_uuid", "value": "", "description": "(Required) " } ] }, "description": "This operation is to retrieve all payment requests initiated for an agreement in the provided period (date range). Payment requests for a period of maximum one year or less than it can be retrieved at a time.\n\n By default, all payment initiation requests (along with details) irrespective of the status will be listed via this endpoint. However, the results can be filtered based on status(es) if needed.\n\nRequest parameter descriptions:\n\n - status - List of valid agreement statuses. Example - Retrieve active and suspended payments only.\n - Valid values - PENDING_PAYMENT_INITIATION, PAYMENT_INITIATED, PAYMENT_INITIATION_COMPLETED, PAYMENT_INITIATION_REJECTED\n - start_date - Date range start, example - fetch all payments created between June to December 2022.\n - end_date - Date range end, example - fetch all payments created between June to December 2022.\n - size - Number of payments per page. Default value is 20.\n - page - Page number. Default value is 0." }, "response": [ { "id": "012277b8-fe89-454b-a858-2b4485b43c18", "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests?start_date=&end_date=&status=PAYMENT_INITIATION_REJECTED&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests" ], "query": [ { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "status", "value": "PAYMENT_INITIATION_REJECTED" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total_count\": \"\",\n \"initiate_payment_status_responses\": [\n {\n \"payment_request_uuid\": \"\",\n \"instruction_id\": \"\",\n \"agreement_uuid\": \"\",\n \"agreement_id\": \"\",\n \"status\": \"PENDING_PAYMENT_INITIATION\",\n \"status_description\": \"\",\n \"status_reason_code\": \"\",\n \"status_reason_description\": \"\",\n \"payment_reconciled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_info\": {\n \"instruction_id\": \"\",\n \"instructed_amount\": \"\",\n \"last_payment\": false,\n \"end_to_end_id\": \"\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n },\n \"retry_attempts\": {\n \"count\": \"\",\n \"retry_info\": [\n {\n \"instruction_id\": \"\",\n \"status\": \"PAYMENT_REJECTED\",\n \"status_description\": \"\",\n \"status_reason_code\": \"\",\n \"status_reason_description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_info\": {\n \"instruction_id\": \"\",\n \"instructed_amount\": \"\",\n \"last_payment\": false,\n \"end_to_end_id\": \"\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n }\n },\n {\n \"instruction_id\": \"\",\n \"status\": \"PAYMENT_REJECTED\",\n \"status_description\": \"\",\n \"status_reason_code\": \"\",\n \"status_reason_description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_info\": {\n \"instruction_id\": \"\",\n \"instructed_amount\": \"\",\n \"last_payment\": false,\n \"end_to_end_id\": \"\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n }\n }\n ]\n }\n },\n {\n \"payment_request_uuid\": \"\",\n \"instruction_id\": \"\",\n \"agreement_uuid\": \"\",\n \"agreement_id\": \"\",\n \"status\": \"PENDING_PAYMENT_INITIATION\",\n \"status_description\": \"\",\n \"status_reason_code\": \"\",\n \"status_reason_description\": \"\",\n \"payment_reconciled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_info\": {\n \"instruction_id\": \"\",\n \"instructed_amount\": \"\",\n \"last_payment\": false,\n \"end_to_end_id\": \"\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n },\n \"retry_attempts\": {\n \"count\": \"\",\n \"retry_info\": [\n {\n \"instruction_id\": \"\",\n \"status\": \"PAYMENT_REJECTED\",\n \"status_description\": \"\",\n \"status_reason_code\": \"\",\n \"status_reason_description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_info\": {\n \"instruction_id\": \"\",\n \"instructed_amount\": \"\",\n \"last_payment\": false,\n \"end_to_end_id\": \"\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n }\n },\n {\n \"instruction_id\": \"\",\n \"status\": \"PAYMENT_REJECTED\",\n \"status_description\": \"\",\n \"status_reason_code\": \"\",\n \"status_reason_description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_info\": {\n \"instruction_id\": \"\",\n \"instructed_amount\": \"\",\n \"last_payment\": false,\n \"end_to_end_id\": \"\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n }\n }\n ]\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-012277b8-fe89-454b-a858-2b4485b43c18" }, { "id": "293c136a-7cd7-4eb3-a10c-deb27679bebf", "name": "Bad Request \n \n \"
Error CodeError Message
PAYT-ERR-1058Invalid Request: Failed to read the request.
PAYT-ERR-1052Invalid Data: [FieldName] provided should contain any", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests?start_date=&end_date=&status=PAYMENT_INITIATION_REJECTED&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests" ], "query": [ { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "status", "value": "PAYMENT_INITIATION_REJECTED" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-293c136a-7cd7-4eb3-a10c-deb27679bebf" }, { "id": "61075517-e8d1-445c-8ad3-5c30d0414acd", "name": "Unauthorised \n
Error CodeError Message
PAYT-ERR-1000Invalid or missing authorisation token.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests?start_date=&end_date=&status=PAYMENT_INITIATION_REJECTED&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests" ], "query": [ { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "status", "value": "PAYMENT_INITIATION_REJECTED" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-61075517-e8d1-445c-8ad3-5c30d0414acd" }, { "id": "890f03ab-0e79-4558-bd74-4c663b8f6b7a", "name": "Forbidden \n
Error CodeError Message
PAYT-ERR-1001PayTo feature not available.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests?start_date=&end_date=&status=PAYMENT_INITIATION_REJECTED&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests" ], "query": [ { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "status", "value": "PAYMENT_INITIATION_REJECTED" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-890f03ab-0e79-4558-bd74-4c663b8f6b7a" }, { "id": "8c9974a0-794b-420c-a9f9-12e36aa6f887", "name": "Not Found \n
Error CodeError Message
PAYT-ERR-2400Agreement with provided uuid does not exist.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests?start_date=&end_date=&status=PAYMENT_INITIATION_REJECTED&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests" ], "query": [ { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "status", "value": "PAYMENT_INITIATION_REJECTED" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-8c9974a0-794b-420c-a9f9-12e36aa6f887" }, { "id": "b053e493-9883-463e-8b15-a205efb87605", "name": "Internal Server Error \n
Error CodeError Message
PAYT-ERR-1003An error occurred processing your request. Please try again.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/payment_requests?start_date=&end_date=&status=PAYMENT_INITIATION_REJECTED&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "payment_requests" ], "query": [ { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "status", "value": "PAYMENT_INITIATION_REJECTED" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-b053e493-9883-463e-8b15-a205efb87605" } ], "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-694ec675-e61b-48d7-ba39-bd6ac7bff4cf" } ], "id": "b75e7772-74f3-4d73-8936-07a6e9e0b5ea", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-b75e7772-74f3-4d73-8936-07a6e9e0b5ea" }, { "name": "create", "item": [ { "name": "Create PayTo Agreement", "id": "56f4175a-ea89-4614-a1af-b0bb85cbd23f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/create", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "create" ], "variable": [ { "id": "99b56ef0-2822-4e45-8601-8f3771a3718b", "key": "agreement_uuid", "value": "", "description": "(Required) " } ] }, "description": "This operation creates the agreement with NPPA and hence must be invoked only after validating the agreement via the \u201cValidate PayTo Agreement\u201d operation.\n\n It should be invoked immediately once the agreement has been validated successfully and resolved PayID details are confirmed with the user.\n\n Agreement Creation will be successful only if it is performed within 5 minutes post successful validation.\n\n Post successful creation, agreement id (generated by NPPA) which uniquely identifies the agreement will be notified. \n\n Note - AUPM agreements will be ACTIVE only post debtor authorization. By default (if custom expiry duration is not provided via response_requested_by field), debtor will have 5 days to authorise the agreement, post which the authorization request will expire automatically and the agreement will be marked as CANCELLED.\n MGCR agreements will be ACTIVE immediately post creation however, payments can be initiated only after 5 calendar days." }, "response": [ { "id": "37e79ca6-81cb-4413-a81d-ab7847ce2bbc", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/create", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "create" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"agreement_uuid\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-37e79ca6-81cb-4413-a81d-ab7847ce2bbc" }, { "id": "86c946f1-d9f1-444e-bf40-91a6b1b405fb", "name": "Bad Request \n \n
Error CodeError Message
PAYT-ERR-2102Invalid format for url param: agreement_uuid.
", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/create", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "create" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-86c946f1-d9f1-444e-bf40-91a6b1b405fb" }, { "id": "428281bb-3937-422e-a040-b804ad6f672a", "name": "Unauthorised \n
Error CodeError Message
PAYT-ERR-1000Invalid or missing authorisation token.
", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/create", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "create" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-428281bb-3937-422e-a040-b804ad6f672a" }, { "id": "4394f31b-0b5d-4403-b085-7db59fc1c761", "name": "Forbidden \n" } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/create", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "create" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-4394f31b-0b5d-4403-b085-7db59fc1c761" }, { "id": "72eaa56c-e57a-4f00-a065-af7bf136fbc5", "name": "Not Found \n
Error CodeError Message
PAYT-ERR-1001PayTo feature not available.
PAYT-ERR-1002Request rejected: User associated with the agreement is not active.
Error CodeError Message
PAYT-ERR-2100Agreement should be in VALIDATED state for creation.
", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/create", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "create" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-72eaa56c-e57a-4f00-a065-af7bf136fbc5" }, { "id": "41e81f34-ab63-496e-bccf-af598327368f", "name": "Resource Unavailable \n" } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/create", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "create" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Gone", "code": 410, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-41e81f34-ab63-496e-bccf-af598327368f" }, { "id": "7a81b812-bfe1-4916-83f8-e1d4022ec339", "name": "Internal Server Error \n
Error CodeError Message
PAYT-ERR-2101Agreement creation is allowed only within a limited time period post validation. Please validate the agreement details again.
Error CodeError Message
PAYT-ERR-1003An error occurred processing your request. Please try again.
", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/create", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "create" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-7a81b812-bfe1-4916-83f8-e1d4022ec339" } ], "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-56f4175a-ea89-4614-a1af-b0bb85cbd23f" } ], "id": "daf7e385-7b02-48c8-ba96-f27222f0cb96", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-daf7e385-7b02-48c8-ba96-f27222f0cb96" }, { "name": "status", "item": [ { "name": "Amend PayTo Agreement Status", "id": "bd31c504-08cc-4bc6-8fa4-413f633609ad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"SUSPENDED\",\n \"reason_code\": \"REQCUST\",\n \"reason_description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/status", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "status" ], "variable": [ { "id": "e7af3a3b-41d9-44e5-a770-a6c932d3c020", "key": "agreement_uuid", "value": "", "description": "(Required) " } ] }, "description": "Amend Status of a particular agreement via its UUID. Below status amends are possible via this API:\n- ACTIVE -> SUSPENDED\n- ACTIVE -> CANCELLED\n- SUSPENDED -> ACTIVE (only if suspended via Zai)\n- SUSPENDED -> CANCELLED\n\nOnly one status amendment is allowed at any given point of time. Example - If a request to suspend the agreement is already in progress, another status change request will not be accepted until the first completes.\n\nResuming a suspended agreement can only be performed by the party that suspended the agreement.\n\nHence, moving the agreement from SUSPENDED to ACTIVE will be accepted only if the Suspension was performed via Zai. CANCELLED is final agreement status and hence is irreversible." }, "response": [ { "id": "fd4cc7d5-3fd4-4f4e-b196-1438749fb9ac", "name": "Accepted", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"SUSPENDED\",\n \"reason_code\": \"REQCUST\",\n \"reason_description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/status", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "status" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"agreement_uuid\": \"\",\n \"agreement_id\": \"\",\n \"status\": \"CANCELLED\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-fd4cc7d5-3fd4-4f4e-b196-1438749fb9ac" }, { "id": "1770d13a-0500-4d15-a9c0-8c07ce25cc3b", "name": "Bad Request \n \n
Error CodeError Message
PAYT-ERR-1050Mandatory info missing: [FieldName] cannot be null or empty.
PAYT-ERR-1051Invalid Data: [FieldName] provided is i", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"SUSPENDED\",\n \"reason_code\": \"REQCUST\",\n \"reason_description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/status", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "status" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-1770d13a-0500-4d15-a9c0-8c07ce25cc3b" }, { "id": "6e209315-508b-4e4e-9d77-19e657598dbf", "name": "Unauthorised \n
Error CodeError Message
PAYT-ERR-1000Invalid or missing authorisation token.
", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"SUSPENDED\",\n \"reason_code\": \"REQCUST\",\n \"reason_description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/status", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "status" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-6e209315-508b-4e4e-9d77-19e657598dbf" }, { "id": "9080212a-2929-4d06-8f79-66ec6da36f1b", "name": "Forbidden \n" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"SUSPENDED\",\n \"reason_code\": \"REQCUST\",\n \"reason_description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/status", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "status" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-9080212a-2929-4d06-8f79-66ec6da36f1b" }, { "id": "9afbc42d-d079-49c1-b4a1-d722a9315988", "name": "Not Found \n
Error CodeError Message
PAYT-ERR-1001PayTo feature not available.
PAYT-ERR-1002Request rejected: User associated with the agreement is not active.
Error CodeError Message
PAYT-ERR-2200Agreement with provided uuid does not exist.
", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"SUSPENDED\",\n \"reason_code\": \"REQCUST\",\n \"reason_description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/status", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "status" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-9afbc42d-d079-49c1-b4a1-d722a9315988" }, { "id": "2f041131-53b9-4f66-b324-0b326950c6b4", "name": "Conflict \n
Error CodeError Message
PAYT-ERR-2201A status amendment for this agreement is already in progress. Please try again later.
", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"SUSPENDED\",\n \"reason_code\": \"REQCUST\",\n \"reason_description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/status", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "status" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-2f041131-53b9-4f66-b324-0b326950c6b4" }, { "id": "2130d81f-530c-45b0-ab05-d84ddd2474fa", "name": "Internal Server Error \n
Error CodeError Message
PAYT-ERR-1003An error occurred processing your request. Please try again.
", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"SUSPENDED\",\n \"reason_code\": \"REQCUST\",\n \"reason_description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/status", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "status" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-2130d81f-530c-45b0-ab05-d84ddd2474fa" } ], "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-bd31c504-08cc-4bc6-8fa4-413f633609ad" } ], "id": "755347c4-6353-4261-91c1-74f6736c3acb", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-755347c4-6353-4261-91c1-74f6736c3acb" }, { "name": "recall", "item": [ { "name": "Recall PayTo Agreement", "id": "142cdf60-d71d-4f4d-bbf2-d55995328c23", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/recall", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "recall" ], "variable": [ { "id": "74748b5a-ce4e-488a-929c-fcb63a803651", "key": "agreement_uuid", "value": "", "description": "(Required) " } ] }, "description": "This operation is to recall a pending agreement creation/bilateral amendment authorisation request before it is approved by debtor. By default, all debtor authorization requests expire after 5 days post creation. If a custom expiry duration (anything less than 5 days) has been specified in the request via \u201cresponse_requested_by\u201d field, then this Recall API should be invoke to expire the authorisation request post the custom duration has elapsed.\n\n Example - For a use-case, if the debtor should approve/reject the agreement within 15 mins post creation, and if the debtor does not respond within 15 mins, this API should be invoked to recall the agreement creation action post 15 mins.\n\nRecall Agreement Creation - If a custom expiry duration is specified during agreement validation step, this API should be used to recall the pending agreement creation authorisation request.\n- Allows recalling agreement authorisation request only for AUPM agreement type.\n- After the recall operation is successful, the current agreement would be considered as CANCELLED and a new agreement should be created to seek the debtor\u2019s approval again.\n\nRecall Bilateral Amendment Request - If a custom expiry duration is specified during bilateral agreement amendment, this API should be used to recall the pending amendment authorisation request.\n- Allows recalling amendment authorisation requests for both AUPM and MGCR agreement types.\n- After the recall operation is successful, the bilateral amendments are discarded and the agreement is not updated. If the changes are still needed, a new amendment request should be created to seek the debtor\u2019s approval again.\n" }, "response": [ { "id": "8a256434-25cb-40e6-be03-d5b722ba437f", "name": "Accepted", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/recall", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "recall" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-8a256434-25cb-40e6-be03-d5b722ba437f" }, { "id": "8b2e00a0-ad37-468e-82ee-daff4c400585", "name": "Bad Request \n \n
Error CodeError Message
PAYT-ERR-2502Recall request rejected: Recall action is applicable only for agreements in CREATED/ACTIVE/SUSPENDED statuses.
PAYT-ERR-2", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/recall", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "recall" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-8b2e00a0-ad37-468e-82ee-daff4c400585" }, { "id": "277f51a0-5b39-4b9c-81c8-f250a4c0326b", "name": "Unauthorised \n
Error CodeError Message
PAYT-ERR-1000Invalid or missing authorisation token.
", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/recall", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "recall" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-277f51a0-5b39-4b9c-81c8-f250a4c0326b" }, { "id": "767ab59c-ad37-4ea3-8455-a948ab634b41", "name": "Forbidden \n" } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/recall", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "recall" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-767ab59c-ad37-4ea3-8455-a948ab634b41" }, { "id": "7b7155ba-a253-4f83-aa7e-ed664b45eaf2", "name": "Not Found \n
Error CodeError Message
PAYT-ERR-1001PayTo feature not available.
PAYT-ERR-1002Request rejected: User associated with the agreement is not active.
Error CodeError Message
PAYT-ERR-2500Agreement with provided uuid does not exist.
", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/recall", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "recall" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-7b7155ba-a253-4f83-aa7e-ed664b45eaf2" }, { "id": "ba3c7a65-0384-4d33-a60d-fcd678464d88", "name": "Internal Server Error \n
Error CodeError Message
PAYT-ERR-1003An error occurred processing your request. Please try again.
", "originalRequest": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/recall", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "recall" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-ba3c7a65-0384-4d33-a60d-fcd678464d88" } ], "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-142cdf60-d71d-4f4d-bbf2-d55995328c23" } ], "id": "b5585037-a7af-402d-abd3-e906e52d8ce3", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-b5585037-a7af-402d-abd3-e906e52d8ce3" }, { "name": "amend", "item": [ { "name": "Amend PayTo Agreement Details", "id": "d869ebee-e33e-47a2-8157-e47303cdc73a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"priority\": \"UNATTENDED\",\n \"response_requested_by\": \"2508-02-29T14:56:55Z\",\n \"unilateral_amendments\": {\n \"description\": \"\",\n \"short_description\": \"\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"AUBN\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n }\n },\n \"bilateral_amendments\": {\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"9200-02-29\",\n \"transfer_arrangement\": \"\",\n \"payment_terms\": {\n \"payment_amount_info\": {\n \"amount\": \"65689\",\n \"currency\": \"{AUD}\",\n \"type\": \"USGB\"\n },\n \"first_payment_info\": {\n \"amount\": \"2674189642697983908\",\n \"currency\": \"{AUD}\",\n \"date\": \"5843-12-18\"\n },\n \"last_payment_info\": {\n \"amount\": \"83\",\n \"currency\": \"{AUD}\",\n \"date\": \"6589-12-30\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6233001070787892425\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"20:19:00.4Z\",\n \"point_in_time\": \"0\",\n \"count_per_period\": \"347762016926\",\n \"frequency\": \"HFYRLY\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/amend", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "amend" ], "variable": [ { "id": "0c3d4351-4798-4400-a2d8-c6d5c08bdab3", "key": "agreement_uuid", "value": "", "description": "(Required) " } ] }, "description": "Amend details of a particular agreement via its UUID. There are two types of amendments possible via this operation:\n- Unilateral amendments - which does not need debtor approval and will be effective immediately\n- Bilateral amendments - which does require debtor approval and will be effective post debtor authorisation\n\nOptional fields can also be cleared via an amend request if needed. Passing an hyphen(-) character for any optional field would indicate its value needs to be cleared.\n\nEither unilateral or bilateral amendments will be accepted in an amendment request. Both types of amendments cannot be provided in a single request.\n\nAt any given point of time, only a single unilateral or a single bilateral amendment will be allowed. Example - If a bilateral amendment is already in progress, another bilateral amendment request will not be accepted until the first completes.\n\nUnilateral details that can be amended:\n- description\n- short_description\n- creditor_info\n- payment_initiator_info\n\nBilateral details that can be amended:\n- validity_end_date\n- transfer_arrangement\n- automatic_renewal\n- payment_terms - all fields\n\nNote - Bilateral amendments will be effective only post debtor authorization. Debtor should authorize the amendments within 5 days (default duration) or within the custom expiry duration (response_requested_by) specified in the amendment request." }, "response": [ { "id": "f72cefc4-8ac5-4e57-a1e4-cd74886d6981", "name": "Accepted", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"priority\": \"UNATTENDED\",\n \"response_requested_by\": \"2508-02-29T14:56:55Z\",\n \"unilateral_amendments\": {\n \"description\": \"\",\n \"short_description\": \"\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"AUBN\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n }\n },\n \"bilateral_amendments\": {\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"9200-02-29\",\n \"transfer_arrangement\": \"\",\n \"payment_terms\": {\n \"payment_amount_info\": {\n \"amount\": \"65689\",\n \"currency\": \"{AUD}\",\n \"type\": \"USGB\"\n },\n \"first_payment_info\": {\n \"amount\": \"2674189642697983908\",\n \"currency\": \"{AUD}\",\n \"date\": \"5843-12-18\"\n },\n \"last_payment_info\": {\n \"amount\": \"83\",\n \"currency\": \"{AUD}\",\n \"date\": \"6589-12-30\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6233001070787892425\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"20:19:00.4Z\",\n \"point_in_time\": \"0\",\n \"count_per_period\": \"347762016926\",\n \"frequency\": \"HFYRLY\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/amend", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "amend" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"agreement_uuid\": \"\",\n \"agreement_id\": \"\",\n \"status\": \"SUSPENDED\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-f72cefc4-8ac5-4e57-a1e4-cd74886d6981" }, { "id": "ae78bdbf-f7cb-46ce-8492-5522b5b27e9b", "name": "Bad Request \n \n
Error CodeError Message
PAYT-ERR-1050Mandatory info missing: [FieldName] cannot be null or empty.
PAYT-ERR-1051Invalid Data: [FieldName] provided is i", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"priority\": \"UNATTENDED\",\n \"response_requested_by\": \"2508-02-29T14:56:55Z\",\n \"unilateral_amendments\": {\n \"description\": \"\",\n \"short_description\": \"\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"AUBN\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n }\n },\n \"bilateral_amendments\": {\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"9200-02-29\",\n \"transfer_arrangement\": \"\",\n \"payment_terms\": {\n \"payment_amount_info\": {\n \"amount\": \"65689\",\n \"currency\": \"{AUD}\",\n \"type\": \"USGB\"\n },\n \"first_payment_info\": {\n \"amount\": \"2674189642697983908\",\n \"currency\": \"{AUD}\",\n \"date\": \"5843-12-18\"\n },\n \"last_payment_info\": {\n \"amount\": \"83\",\n \"currency\": \"{AUD}\",\n \"date\": \"6589-12-30\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6233001070787892425\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"20:19:00.4Z\",\n \"point_in_time\": \"0\",\n \"count_per_period\": \"347762016926\",\n \"frequency\": \"HFYRLY\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/amend", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "amend" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-ae78bdbf-f7cb-46ce-8492-5522b5b27e9b" }, { "id": "adb26d5b-73b2-494c-a96a-7cf1671fd068", "name": "Unauthorised \n
Error CodeError Message
PAYT-ERR-1000Invalid or missing authorisation token.
", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"priority\": \"UNATTENDED\",\n \"response_requested_by\": \"2508-02-29T14:56:55Z\",\n \"unilateral_amendments\": {\n \"description\": \"\",\n \"short_description\": \"\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"AUBN\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n }\n },\n \"bilateral_amendments\": {\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"9200-02-29\",\n \"transfer_arrangement\": \"\",\n \"payment_terms\": {\n \"payment_amount_info\": {\n \"amount\": \"65689\",\n \"currency\": \"{AUD}\",\n \"type\": \"USGB\"\n },\n \"first_payment_info\": {\n \"amount\": \"2674189642697983908\",\n \"currency\": \"{AUD}\",\n \"date\": \"5843-12-18\"\n },\n \"last_payment_info\": {\n \"amount\": \"83\",\n \"currency\": \"{AUD}\",\n \"date\": \"6589-12-30\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6233001070787892425\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"20:19:00.4Z\",\n \"point_in_time\": \"0\",\n \"count_per_period\": \"347762016926\",\n \"frequency\": \"HFYRLY\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/amend", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "amend" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-adb26d5b-73b2-494c-a96a-7cf1671fd068" }, { "id": "fe5003de-8830-4e59-8e52-a9fbee1843fd", "name": "Forbidden \n" } ], "body": { "mode": "raw", "raw": "{\n \"priority\": \"UNATTENDED\",\n \"response_requested_by\": \"2508-02-29T14:56:55Z\",\n \"unilateral_amendments\": {\n \"description\": \"\",\n \"short_description\": \"\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"AUBN\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n }\n },\n \"bilateral_amendments\": {\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"9200-02-29\",\n \"transfer_arrangement\": \"\",\n \"payment_terms\": {\n \"payment_amount_info\": {\n \"amount\": \"65689\",\n \"currency\": \"{AUD}\",\n \"type\": \"USGB\"\n },\n \"first_payment_info\": {\n \"amount\": \"2674189642697983908\",\n \"currency\": \"{AUD}\",\n \"date\": \"5843-12-18\"\n },\n \"last_payment_info\": {\n \"amount\": \"83\",\n \"currency\": \"{AUD}\",\n \"date\": \"6589-12-30\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6233001070787892425\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"20:19:00.4Z\",\n \"point_in_time\": \"0\",\n \"count_per_period\": \"347762016926\",\n \"frequency\": \"HFYRLY\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/amend", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "amend" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-fe5003de-8830-4e59-8e52-a9fbee1843fd" }, { "id": "c61c8993-55aa-4700-8981-cc6424183593", "name": "Not Found \n
Error CodeError Message
PAYT-ERR-1001PayTo feature not available.
PAYT-ERR-1002Request rejected: User associated with the agreement is not active.
Error CodeError Message
PAYT-ERR-2300Agreement with provided uuid does not exist.
", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"priority\": \"UNATTENDED\",\n \"response_requested_by\": \"2508-02-29T14:56:55Z\",\n \"unilateral_amendments\": {\n \"description\": \"\",\n \"short_description\": \"\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"AUBN\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n }\n },\n \"bilateral_amendments\": {\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"9200-02-29\",\n \"transfer_arrangement\": \"\",\n \"payment_terms\": {\n \"payment_amount_info\": {\n \"amount\": \"65689\",\n \"currency\": \"{AUD}\",\n \"type\": \"USGB\"\n },\n \"first_payment_info\": {\n \"amount\": \"2674189642697983908\",\n \"currency\": \"{AUD}\",\n \"date\": \"5843-12-18\"\n },\n \"last_payment_info\": {\n \"amount\": \"83\",\n \"currency\": \"{AUD}\",\n \"date\": \"6589-12-30\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6233001070787892425\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"20:19:00.4Z\",\n \"point_in_time\": \"0\",\n \"count_per_period\": \"347762016926\",\n \"frequency\": \"HFYRLY\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/amend", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "amend" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-c61c8993-55aa-4700-8981-cc6424183593" }, { "id": "75397848-1555-43ea-b495-8f4b3f46b630", "name": "Conflict \n
Error CodeError Message
PAYT-ERR-2301A bilateral amendment for this agreement is already in progress. Please try again later.
PAYT-ERR-2319A unilateral ame", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"priority\": \"UNATTENDED\",\n \"response_requested_by\": \"2508-02-29T14:56:55Z\",\n \"unilateral_amendments\": {\n \"description\": \"\",\n \"short_description\": \"\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"AUBN\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n }\n },\n \"bilateral_amendments\": {\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"9200-02-29\",\n \"transfer_arrangement\": \"\",\n \"payment_terms\": {\n \"payment_amount_info\": {\n \"amount\": \"65689\",\n \"currency\": \"{AUD}\",\n \"type\": \"USGB\"\n },\n \"first_payment_info\": {\n \"amount\": \"2674189642697983908\",\n \"currency\": \"{AUD}\",\n \"date\": \"5843-12-18\"\n },\n \"last_payment_info\": {\n \"amount\": \"83\",\n \"currency\": \"{AUD}\",\n \"date\": \"6589-12-30\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6233001070787892425\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"20:19:00.4Z\",\n \"point_in_time\": \"0\",\n \"count_per_period\": \"347762016926\",\n \"frequency\": \"HFYRLY\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/amend", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "amend" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-75397848-1555-43ea-b495-8f4b3f46b630" }, { "id": "88d3c686-dee8-4e8a-a79c-d078f37d946b", "name": "Internal Server Error \n
Error CodeError Message
PAYT-ERR-1003An error occurred processing your request. Please try again.
", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"priority\": \"UNATTENDED\",\n \"response_requested_by\": \"2508-02-29T14:56:55Z\",\n \"unilateral_amendments\": {\n \"description\": \"\",\n \"short_description\": \"\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"AUBN\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n }\n },\n \"bilateral_amendments\": {\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"9200-02-29\",\n \"transfer_arrangement\": \"\",\n \"payment_terms\": {\n \"payment_amount_info\": {\n \"amount\": \"65689\",\n \"currency\": \"{AUD}\",\n \"type\": \"USGB\"\n },\n \"first_payment_info\": {\n \"amount\": \"2674189642697983908\",\n \"currency\": \"{AUD}\",\n \"date\": \"5843-12-18\"\n },\n \"last_payment_info\": {\n \"amount\": \"83\",\n \"currency\": \"{AUD}\",\n \"date\": \"6589-12-30\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6233001070787892425\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"20:19:00.4Z\",\n \"point_in_time\": \"0\",\n \"count_per_period\": \"347762016926\",\n \"frequency\": \"HFYRLY\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid/amend", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid", "amend" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-88d3c686-dee8-4e8a-a79c-d078f37d946b" } ], "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-d869ebee-e33e-47a2-8157-e47303cdc73a" } ], "id": "f7e8c312-e9ac-409a-bb15-c5564dce22d1", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-f7e8c312-e9ac-409a-bb15-c5564dce22d1" }, { "name": "Get PayTo Agreement Details", "id": "bcd466aa-9ea7-44d8-bb6e-690688d56563", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid" ], "variable": [ { "id": "f9fe3a9e-296d-4f1e-a3c7-e51849bb1612", "key": "agreement_uuid", "value": "", "description": "(Required) " } ] }, "description": "Retrieve details of a PayTo agreement by UUID which uniquely identifies the agreement.\n This UUID is returned as part of the \u201cValidate PayTo Agreement\u201d operation.\n\n It provides complete details of a particular agreement irrespective of its current status " }, "response": [ { "id": "07f981a9-0d3e-4cf4-8b40-32529874cc6e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"agreement_uuid\": \"\",\n \"user_external_id\": \"\",\n \"status\": \"\",\n \"status_description\": \"\",\n \"status_reason_code\": \"\",\n \"status_reason_description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"agreement_info\": {\n \"agreement_id\": \"\",\n \"description\": \"\",\n \"short_description\": \"\",\n \"purpose_code\": \"PENS\",\n \"agreement_type\": \"MGCR\",\n \"automatic_renewal\": \"\",\n \"validity_start_date\": \"2741-10-31\",\n \"validity_end_date\": \"7559-12-22\",\n \"transfer_arrangement\": \"\",\n \"debtor_info\": {\n \"debtor_account_details\": {\n \"account_id\": \"\",\n \"account_id_type\": \"PAYID\",\n \"payid_details\": {\n \"payid_type\": \"AUBN\",\n \"payid\": \"\",\n \"payid_name\": \"\"\n }\n },\n \"debtor_details\": {\n \"debtor_name\": \"\",\n \"debtor_type\": \"ORGN\",\n \"ultimate_debtor_name\": \"\",\n \"debtor_id\": \"\",\n \"debtor_id_type\": \"GS1G\",\n \"debtor_reference\": \"\"\n }\n },\n \"creditor_info\": {\n \"creditor_account_details\": {\n \"account_id\": \"\",\n \"account_id_type\": \"BBAN\"\n },\n \"creditor_details\": {\n \"creditor_id\": \"\",\n \"creditor_id_type\": \"NIDN\",\n \"creditor_name\": \"\",\n \"creditor_type\": \"ORGN\",\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n }\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"CCPT\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n },\n \"payment_terms\": {\n \"payment_amount_info\": {\n \"amount\": \"\",\n \"currency\": \"ZRA\",\n \"type\": \"USGB\"\n },\n \"first_payment_info\": {\n \"amount\": \"\",\n \"currency\": \"DHH\",\n \"date\": \"9600-02-29\"\n },\n \"last_payment_info\": {\n \"amount\": \"\",\n \"currency\": \"CSW\",\n \"date\": \"6313-01-24\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"\",\n \"currency\": \"NZV\"\n },\n \"payment_executed_not_before_time\": \"\",\n \"point_in_time\": \"\",\n \"count_per_period\": \"\",\n \"frequency\": \"QURTLY\"\n }\n }\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-07f981a9-0d3e-4cf4-8b40-32529874cc6e" }, { "id": "da712c97-3c00-428a-8071-ef67aaf87ea9", "name": "Bad Request \n \n
Error CodeError Message
PAYT-ERR-2401Invalid format for url param: agreement_uuid.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-da712c97-3c00-428a-8071-ef67aaf87ea9" }, { "id": "ab60fb05-91ab-48af-a0de-28ba5c8be16d", "name": "Unauthorised \n
Error CodeError Message
PAYT-ERR-1000Invalid or missing authorisation token.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-ab60fb05-91ab-48af-a0de-28ba5c8be16d" }, { "id": "a87fdc57-bc19-423f-b7a7-bb3f93f9f64d", "name": "Forbidden \n
Error CodeError Message
PAYT-ERR-1001PayTo feature not available.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-a87fdc57-bc19-423f-b7a7-bb3f93f9f64d" }, { "id": "6928b525-1ba0-4ac3-97bf-0a49c250284e", "name": "Not Found \n
Error CodeError Message
PAYT-ERR-2400Agreement with provided uuid does not exist.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-6928b525-1ba0-4ac3-97bf-0a49c250284e" }, { "id": "68ec972d-405b-4d0f-8ba1-755200208157", "name": "Internal Server Error \n
Error CodeError Message
PAYT-ERR-1003An error occurred processing your request. Please try again.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements/:agreement_uuid", "host": [ "{{baseUrl}}" ], "path": [ "agreements", ":agreement_uuid" ], "variable": [ { "key": "agreement_uuid" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-68ec972d-405b-4d0f-8ba1-755200208157" } ], "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-bcd466aa-9ea7-44d8-bb6e-690688d56563" } ], "id": "8f68d4df-4dd9-4abe-92dd-730fedac9145", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-8f68d4df-4dd9-4abe-92dd-730fedac9145" }, { "name": "validate", "item": [ { "name": "Validate PayTo Agreement", "id": "b214e84f-6f55-4140-aafb-f3bb67ee1b94", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agreement_info\": {\n \"agreement_type\": \"MGCR\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"debtor_info\": {\n \"debtor_account_details\": {\n \"account_id_type\": \"PAYID\",\n \"account_id\": \"\",\n \"payid_details\": {\n \"payid_type\": \"TELI\",\n \"payid\": \"\"\n }\n },\n \"debtor_details\": {\n \"debtor_name\": \"\",\n \"debtor_type\": \"ORGN\",\n \"ultimate_debtor_name\": \"\",\n \"debtor_id\": \"\",\n \"debtor_id_type\": \"AUCN\",\n \"debtor_reference\": \"\"\n }\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"CUST\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n },\n \"payment_terms\": {\n \"frequency\": \"QURTLY\",\n \"payment_amount_info\": {\n \"amount\": \"992\",\n \"currency\": \"{AUD}\",\n \"type\": \"FIXE\"\n },\n \"first_payment_info\": {\n \"amount\": \"215515758\",\n \"currency\": \"{AUD}\",\n \"date\": \"3188-10-10\"\n },\n \"last_payment_info\": {\n \"amount\": \"691406561737500\",\n \"currency\": \"{AUD}\",\n \"date\": \"5910-10-31\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6055\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"10:02:11.6Z\",\n \"point_in_time\": \"2\",\n \"count_per_period\": \"318859\"\n },\n \"purpose_code\": \"OTHR\",\n \"validity_start_date\": \"6186-01-31\",\n \"description\": \"\",\n \"short_description\": \"\",\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"7200-02-29\",\n \"transfer_arrangement\": \"\"\n },\n \"priority\": \"ATTENDED\",\n \"user_external_id\": \"\",\n \"response_requested_by\": \"8400-02-29T12:30:23.9Z\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/validate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", "validate" ] }, "description": "Validate PayTo agreement details before creation. This operation must be invoked first, followed by the \u201cCreate PayTo Agreement\u201d operation.\n\n This operation validates the details of the agreements along with ensuring the debtor and creditor are NPP and PayTo reachable before the actual agreement creation with NPPA.\n\n PayID details provided for the debtor are also resolved as part of this operation. Customers should share the resolved PayID details with their users for confirmation before the actual agreement creation.\n\n Post successful validation, agreement UUID is returned in the response which uniquely identifies the agreement. This UUID should be used in subsequent API calls for that particular agreement.\n\n Note - Zai may reformat the debtor account number if it is not as per the format expected by payer institutions. Reformatted debtor account number can be accessed either via GET PayTo Agreement Details API after the validation step or via WAPI notification sent by Zai after successful agreement creation step." }, "response": [ { "id": "a1ada7ec-b695-42b9-a957-9ea8df01c454", "name": "Accepted", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"agreement_info\": {\n \"agreement_type\": \"MGCR\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"debtor_info\": {\n \"debtor_account_details\": {\n \"account_id_type\": \"PAYID\",\n \"account_id\": \"\",\n \"payid_details\": {\n \"payid_type\": \"TELI\",\n \"payid\": \"\"\n }\n },\n \"debtor_details\": {\n \"debtor_name\": \"\",\n \"debtor_type\": \"ORGN\",\n \"ultimate_debtor_name\": \"\",\n \"debtor_id\": \"\",\n \"debtor_id_type\": \"AUCN\",\n \"debtor_reference\": \"\"\n }\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"CUST\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n },\n \"payment_terms\": {\n \"frequency\": \"QURTLY\",\n \"payment_amount_info\": {\n \"amount\": \"992\",\n \"currency\": \"{AUD}\",\n \"type\": \"FIXE\"\n },\n \"first_payment_info\": {\n \"amount\": \"215515758\",\n \"currency\": \"{AUD}\",\n \"date\": \"3188-10-10\"\n },\n \"last_payment_info\": {\n \"amount\": \"691406561737500\",\n \"currency\": \"{AUD}\",\n \"date\": \"5910-10-31\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6055\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"10:02:11.6Z\",\n \"point_in_time\": \"2\",\n \"count_per_period\": \"318859\"\n },\n \"purpose_code\": \"OTHR\",\n \"validity_start_date\": \"6186-01-31\",\n \"description\": \"\",\n \"short_description\": \"\",\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"7200-02-29\",\n \"transfer_arrangement\": \"\"\n },\n \"priority\": \"ATTENDED\",\n \"user_external_id\": \"\",\n \"response_requested_by\": \"8400-02-29T12:30:23.9Z\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/validate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", "validate" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"agreement_uuid\": \"\",\n \"status\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-a1ada7ec-b695-42b9-a957-9ea8df01c454" }, { "id": "235a09c0-6d38-4f0c-be7d-ab6309203b99", "name": "Bad Request \n \n
Error CodeError Message
PAYT-ERR-1050Mandatory info missing: [FieldName] cannot be null or empty.
PAYT-ERR-1051Invalid Data: [FieldName] provided is ", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"agreement_info\": {\n \"agreement_type\": \"MGCR\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"debtor_info\": {\n \"debtor_account_details\": {\n \"account_id_type\": \"PAYID\",\n \"account_id\": \"\",\n \"payid_details\": {\n \"payid_type\": \"TELI\",\n \"payid\": \"\"\n }\n },\n \"debtor_details\": {\n \"debtor_name\": \"\",\n \"debtor_type\": \"ORGN\",\n \"ultimate_debtor_name\": \"\",\n \"debtor_id\": \"\",\n \"debtor_id_type\": \"AUCN\",\n \"debtor_reference\": \"\"\n }\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"CUST\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n },\n \"payment_terms\": {\n \"frequency\": \"QURTLY\",\n \"payment_amount_info\": {\n \"amount\": \"992\",\n \"currency\": \"{AUD}\",\n \"type\": \"FIXE\"\n },\n \"first_payment_info\": {\n \"amount\": \"215515758\",\n \"currency\": \"{AUD}\",\n \"date\": \"3188-10-10\"\n },\n \"last_payment_info\": {\n \"amount\": \"691406561737500\",\n \"currency\": \"{AUD}\",\n \"date\": \"5910-10-31\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6055\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"10:02:11.6Z\",\n \"point_in_time\": \"2\",\n \"count_per_period\": \"318859\"\n },\n \"purpose_code\": \"OTHR\",\n \"validity_start_date\": \"6186-01-31\",\n \"description\": \"\",\n \"short_description\": \"\",\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"7200-02-29\",\n \"transfer_arrangement\": \"\"\n },\n \"priority\": \"ATTENDED\",\n \"user_external_id\": \"\",\n \"response_requested_by\": \"8400-02-29T12:30:23.9Z\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/validate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", "validate" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-235a09c0-6d38-4f0c-be7d-ab6309203b99" }, { "id": "1c19743a-5bc7-49d8-aada-c2d5f8824a50", "name": "Unauthorised \n
Error CodeError Message
PAYT-ERR-1000Invalid or missing authorisation token.
", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"agreement_info\": {\n \"agreement_type\": \"MGCR\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"debtor_info\": {\n \"debtor_account_details\": {\n \"account_id_type\": \"PAYID\",\n \"account_id\": \"\",\n \"payid_details\": {\n \"payid_type\": \"TELI\",\n \"payid\": \"\"\n }\n },\n \"debtor_details\": {\n \"debtor_name\": \"\",\n \"debtor_type\": \"ORGN\",\n \"ultimate_debtor_name\": \"\",\n \"debtor_id\": \"\",\n \"debtor_id_type\": \"AUCN\",\n \"debtor_reference\": \"\"\n }\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"CUST\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n },\n \"payment_terms\": {\n \"frequency\": \"QURTLY\",\n \"payment_amount_info\": {\n \"amount\": \"992\",\n \"currency\": \"{AUD}\",\n \"type\": \"FIXE\"\n },\n \"first_payment_info\": {\n \"amount\": \"215515758\",\n \"currency\": \"{AUD}\",\n \"date\": \"3188-10-10\"\n },\n \"last_payment_info\": {\n \"amount\": \"691406561737500\",\n \"currency\": \"{AUD}\",\n \"date\": \"5910-10-31\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6055\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"10:02:11.6Z\",\n \"point_in_time\": \"2\",\n \"count_per_period\": \"318859\"\n },\n \"purpose_code\": \"OTHR\",\n \"validity_start_date\": \"6186-01-31\",\n \"description\": \"\",\n \"short_description\": \"\",\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"7200-02-29\",\n \"transfer_arrangement\": \"\"\n },\n \"priority\": \"ATTENDED\",\n \"user_external_id\": \"\",\n \"response_requested_by\": \"8400-02-29T12:30:23.9Z\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/validate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", "validate" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-1c19743a-5bc7-49d8-aada-c2d5f8824a50" }, { "id": "beb48f69-1164-4611-83fa-3166d5b6d9d7", "name": "Forbidden \n
Error CodeError Message
PAYT-ERR-1001PayTo feature not available.
PAYT-ERR-1004User with provided user_external_id does not exist.
", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"agreement_info\": {\n \"agreement_type\": \"MGCR\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"debtor_info\": {\n \"debtor_account_details\": {\n \"account_id_type\": \"PAYID\",\n \"account_id\": \"\",\n \"payid_details\": {\n \"payid_type\": \"TELI\",\n \"payid\": \"\"\n }\n },\n \"debtor_details\": {\n \"debtor_name\": \"\",\n \"debtor_type\": \"ORGN\",\n \"ultimate_debtor_name\": \"\",\n \"debtor_id\": \"\",\n \"debtor_id_type\": \"AUCN\",\n \"debtor_reference\": \"\"\n }\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"CUST\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n },\n \"payment_terms\": {\n \"frequency\": \"QURTLY\",\n \"payment_amount_info\": {\n \"amount\": \"992\",\n \"currency\": \"{AUD}\",\n \"type\": \"FIXE\"\n },\n \"first_payment_info\": {\n \"amount\": \"215515758\",\n \"currency\": \"{AUD}\",\n \"date\": \"3188-10-10\"\n },\n \"last_payment_info\": {\n \"amount\": \"691406561737500\",\n \"currency\": \"{AUD}\",\n \"date\": \"5910-10-31\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6055\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"10:02:11.6Z\",\n \"point_in_time\": \"2\",\n \"count_per_period\": \"318859\"\n },\n \"purpose_code\": \"OTHR\",\n \"validity_start_date\": \"6186-01-31\",\n \"description\": \"\",\n \"short_description\": \"\",\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"7200-02-29\",\n \"transfer_arrangement\": \"\"\n },\n \"priority\": \"ATTENDED\",\n \"user_external_id\": \"\",\n \"response_requested_by\": \"8400-02-29T12:30:23.9Z\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/validate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", "validate" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-beb48f69-1164-4611-83fa-3166d5b6d9d7" }, { "id": "adb02e13-3487-46a5-aee6-bb80f755e7c5", "name": "Not Found \n
Error CodeError Message
PAYT-ERR-2000Active user with provided user_external_id does not exist.
", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"agreement_info\": {\n \"agreement_type\": \"MGCR\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"debtor_info\": {\n \"debtor_account_details\": {\n \"account_id_type\": \"PAYID\",\n \"account_id\": \"\",\n \"payid_details\": {\n \"payid_type\": \"TELI\",\n \"payid\": \"\"\n }\n },\n \"debtor_details\": {\n \"debtor_name\": \"\",\n \"debtor_type\": \"ORGN\",\n \"ultimate_debtor_name\": \"\",\n \"debtor_id\": \"\",\n \"debtor_id_type\": \"AUCN\",\n \"debtor_reference\": \"\"\n }\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"CUST\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n },\n \"payment_terms\": {\n \"frequency\": \"QURTLY\",\n \"payment_amount_info\": {\n \"amount\": \"992\",\n \"currency\": \"{AUD}\",\n \"type\": \"FIXE\"\n },\n \"first_payment_info\": {\n \"amount\": \"215515758\",\n \"currency\": \"{AUD}\",\n \"date\": \"3188-10-10\"\n },\n \"last_payment_info\": {\n \"amount\": \"691406561737500\",\n \"currency\": \"{AUD}\",\n \"date\": \"5910-10-31\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6055\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"10:02:11.6Z\",\n \"point_in_time\": \"2\",\n \"count_per_period\": \"318859\"\n },\n \"purpose_code\": \"OTHR\",\n \"validity_start_date\": \"6186-01-31\",\n \"description\": \"\",\n \"short_description\": \"\",\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"7200-02-29\",\n \"transfer_arrangement\": \"\"\n },\n \"priority\": \"ATTENDED\",\n \"user_external_id\": \"\",\n \"response_requested_by\": \"8400-02-29T12:30:23.9Z\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/validate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", "validate" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-adb02e13-3487-46a5-aee6-bb80f755e7c5" }, { "id": "ecd57457-bc65-4baf-a0e1-ebf3a10ccb59", "name": "Internal Server Error \n
Error CodeError Message
PAYT-ERR-1003An error occurred processing your request. Please try again.
", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"agreement_info\": {\n \"agreement_type\": \"MGCR\",\n \"creditor_info\": {\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n },\n \"debtor_info\": {\n \"debtor_account_details\": {\n \"account_id_type\": \"PAYID\",\n \"account_id\": \"\",\n \"payid_details\": {\n \"payid_type\": \"TELI\",\n \"payid\": \"\"\n }\n },\n \"debtor_details\": {\n \"debtor_name\": \"\",\n \"debtor_type\": \"ORGN\",\n \"ultimate_debtor_name\": \"\",\n \"debtor_id\": \"\",\n \"debtor_id_type\": \"AUCN\",\n \"debtor_reference\": \"\"\n }\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"CUST\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n },\n \"payment_terms\": {\n \"frequency\": \"QURTLY\",\n \"payment_amount_info\": {\n \"amount\": \"992\",\n \"currency\": \"{AUD}\",\n \"type\": \"FIXE\"\n },\n \"first_payment_info\": {\n \"amount\": \"215515758\",\n \"currency\": \"{AUD}\",\n \"date\": \"3188-10-10\"\n },\n \"last_payment_info\": {\n \"amount\": \"691406561737500\",\n \"currency\": \"{AUD}\",\n \"date\": \"5910-10-31\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"6055\",\n \"currency\": \"{AUD}\"\n },\n \"payment_executed_not_before_time\": \"10:02:11.6Z\",\n \"point_in_time\": \"2\",\n \"count_per_period\": \"318859\"\n },\n \"purpose_code\": \"OTHR\",\n \"validity_start_date\": \"6186-01-31\",\n \"description\": \"\",\n \"short_description\": \"\",\n \"automatic_renewal\": \"\",\n \"validity_end_date\": \"7200-02-29\",\n \"transfer_arrangement\": \"\"\n },\n \"priority\": \"ATTENDED\",\n \"user_external_id\": \"\",\n \"response_requested_by\": \"8400-02-29T12:30:23.9Z\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/agreements/validate", "host": [ "{{baseUrl}}" ], "path": [ "agreements", "validate" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-ecd57457-bc65-4baf-a0e1-ebf3a10ccb59" } ], "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-b214e84f-6f55-4140-aafb-f3bb67ee1b94" } ], "id": "bf6deb0f-8468-4d3a-9bae-ab29631db0b0", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-bf6deb0f-8468-4d3a-9bae-ab29631db0b0" }, { "name": "Get All PayTo Agreements for a User", "id": "ba9d5286-e578-40ca-af0a-d7376b49d1b0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/agreements?user_external_id=&status=CREATED&agreement_type=&start_date=&end_date=&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements" ], "query": [ { "description": "(Required) ", "key": "user_external_id", "value": "" }, { "key": "status", "value": "CREATED" }, { "key": "agreement_type", "value": "" }, { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ] }, "description": " This operation is to retrieve all PayTo agreements associated with a particular user in the provided period (date range). Agreements can be retrieved for a maximum period of one year or less at a time i.e. the period between start and end date cannot exceed more than one year.\n\n By default, all agreements will be returned irrespective of status and type (AUPM/MGCR).\n\n However, if required, results can be filtered for a particular status or agreement type. Example - Retrieve all suspended and cancelled migrated agreements.\n\nRequest parameter descriptions:\n \n - user_external_id - Unique identifier of the user that is associated with the agreement.\n - status - List of valid agreement statuses. Example - Retrieve active and suspended agreements only.\n - Valid values - PENDING_VALIDATION, VALIDATED, PENDING_CREATION, CREATED, ACTIVE, SUSPENDED, CANCELLED\n - agreement_type - List of valid agreement types. Example - Retrieve only migrated agreements.\n - Valid values - AUPM, MGCR\n - start_date - Date range start, example - fetch all agreements created between June to December 2022.\n - end_date - Date range end, example - fetch all agreements created between June to December 2022.\n - size - Number of agreements per page. Default value is 20.\n - page - Page number. Default value is 0." }, "response": [ { "id": "dc822082-774d-456e-b424-90dfbfa289b5", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements?user_external_id=&status=CREATED&agreement_type=&start_date=&end_date=&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements" ], "query": [ { "description": "(Required) ", "key": "user_external_id", "value": "" }, { "key": "status", "value": "CREATED" }, { "key": "agreement_type", "value": "" }, { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"totalCount\": \"\",\n \"agreements\": [\n {\n \"agreement_uuid\": \"\",\n \"user_external_id\": \"\",\n \"status\": \"\",\n \"status_description\": \"\",\n \"status_reason_code\": \"\",\n \"status_reason_description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"agreement_info\": {\n \"agreement_id\": \"\",\n \"description\": \"\",\n \"short_description\": \"\",\n \"purpose_code\": \"SALA\",\n \"agreement_type\": \"AUPM\",\n \"automatic_renewal\": \"\",\n \"validity_start_date\": \"5844-02-29\",\n \"validity_end_date\": \"6694-05-13\",\n \"transfer_arrangement\": \"\",\n \"debtor_info\": {\n \"debtor_account_details\": {\n \"account_id\": \"\",\n \"account_id_type\": \"BBAN\",\n \"payid_details\": {\n \"payid_type\": \"ORGN\",\n \"payid\": \"\",\n \"payid_name\": \"\"\n }\n },\n \"debtor_details\": {\n \"debtor_name\": \"\",\n \"debtor_type\": \"PERS\",\n \"ultimate_debtor_name\": \"\",\n \"debtor_id\": \"\",\n \"debtor_id_type\": \"CHID\",\n \"debtor_reference\": \"\"\n }\n },\n \"creditor_info\": {\n \"creditor_account_details\": {\n \"account_id\": \"\",\n \"account_id_type\": \"BBAN\"\n },\n \"creditor_details\": {\n \"creditor_id\": \"\",\n \"creditor_id_type\": \"AUCN\",\n \"creditor_name\": \"\",\n \"creditor_type\": \"ORGN\",\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n }\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"CUST\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n },\n \"payment_terms\": {\n \"payment_amount_info\": {\n \"amount\": \"\",\n \"currency\": \"MHW\",\n \"type\": \"FIXE\"\n },\n \"first_payment_info\": {\n \"amount\": \"\",\n \"currency\": \"ZIM\",\n \"date\": \"1992-02-29\"\n },\n \"last_payment_info\": {\n \"amount\": \"\",\n \"currency\": \"TEN\",\n \"date\": \"3832-02-29\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"\",\n \"currency\": \"USJ\"\n },\n \"payment_executed_not_before_time\": \"\",\n \"point_in_time\": \"\",\n \"count_per_period\": \"\",\n \"frequency\": \"INTRDY\"\n }\n }\n },\n {\n \"agreement_uuid\": \"\",\n \"user_external_id\": \"\",\n \"status\": \"\",\n \"status_description\": \"\",\n \"status_reason_code\": \"\",\n \"status_reason_description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"agreement_info\": {\n \"agreement_id\": \"\",\n \"description\": \"\",\n \"short_description\": \"\",\n \"purpose_code\": \"PENS\",\n \"agreement_type\": \"MGCR\",\n \"automatic_renewal\": \"\",\n \"validity_start_date\": \"1218-11-29\",\n \"validity_end_date\": \"7675-09-29\",\n \"transfer_arrangement\": \"\",\n \"debtor_info\": {\n \"debtor_account_details\": {\n \"account_id\": \"\",\n \"account_id_type\": \"PAYID\",\n \"payid_details\": {\n \"payid_type\": \"ORGN\",\n \"payid\": \"\",\n \"payid_name\": \"\"\n }\n },\n \"debtor_details\": {\n \"debtor_name\": \"\",\n \"debtor_type\": \"PERS\",\n \"ultimate_debtor_name\": \"\",\n \"debtor_id\": \"\",\n \"debtor_id_type\": \"BANK\",\n \"debtor_reference\": \"\"\n }\n },\n \"creditor_info\": {\n \"creditor_account_details\": {\n \"account_id\": \"\",\n \"account_id_type\": \"PAYID\"\n },\n \"creditor_details\": {\n \"creditor_id\": \"\",\n \"creditor_id_type\": \"CCPT\",\n \"creditor_name\": \"\",\n \"creditor_type\": \"PERS\",\n \"ultimate_creditor_name\": \"\",\n \"creditor_reference\": \"\"\n }\n },\n \"payment_initiator_info\": {\n \"initiator_id\": \"\",\n \"initiator_id_type_code\": \"SREN\",\n \"initiator_legal_name\": \"\",\n \"initiator_name\": \"\"\n },\n \"payment_terms\": {\n \"payment_amount_info\": {\n \"amount\": \"\",\n \"currency\": \"SMZ\",\n \"type\": \"USGB\"\n },\n \"first_payment_info\": {\n \"amount\": \"\",\n \"currency\": \"YDD\",\n \"date\": \"2400-02-29\"\n },\n \"last_payment_info\": {\n \"amount\": \"\",\n \"currency\": \"NEL\",\n \"date\": \"1935-12-31\"\n },\n \"maximum_amount_info\": {\n \"amount\": \"\",\n \"currency\": \"BEA\"\n },\n \"payment_executed_not_before_time\": \"\",\n \"point_in_time\": \"\",\n \"count_per_period\": \"\",\n \"frequency\": \"INTRDY\"\n }\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-dc822082-774d-456e-b424-90dfbfa289b5" }, { "id": "814a3755-30e5-4e5f-8c69-b1a0c2415279", "name": "Bad Request \n \n
Error CodeError Message
PAYT-ERR-1051Invalid Data: [FieldName] provided is invalid.
PAYT-ERR-1052Invalid Data: [FieldName] provided should contain any", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements?user_external_id=&status=CREATED&agreement_type=&start_date=&end_date=&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements" ], "query": [ { "description": "(Required) ", "key": "user_external_id", "value": "" }, { "key": "status", "value": "CREATED" }, { "key": "agreement_type", "value": "" }, { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-814a3755-30e5-4e5f-8c69-b1a0c2415279" }, { "id": "8e68d220-1d4d-4094-b525-299bef7213e3", "name": "Unauthorised \n
Error CodeError Message
PAYT-ERR-1000Invalid or missing authorisation token.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements?user_external_id=&status=CREATED&agreement_type=&start_date=&end_date=&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements" ], "query": [ { "description": "(Required) ", "key": "user_external_id", "value": "" }, { "key": "status", "value": "CREATED" }, { "key": "agreement_type", "value": "" }, { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-8e68d220-1d4d-4094-b525-299bef7213e3" }, { "id": "54ec8ffe-9d68-42fe-98b4-fec41f891c3f", "name": "Forbidden \n
Error CodeError Message
PAYT-ERR-1001PayTo feature not available.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements?user_external_id=&status=CREATED&agreement_type=&start_date=&end_date=&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements" ], "query": [ { "description": "(Required) ", "key": "user_external_id", "value": "" }, { "key": "status", "value": "CREATED" }, { "key": "agreement_type", "value": "" }, { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-54ec8ffe-9d68-42fe-98b4-fec41f891c3f" }, { "id": "778a6c2b-af0f-4aac-939a-efc50f597bf0", "name": "Internal Server Error \n
Error CodeError Message
PAYT-ERR-1003An error occurred processing your request. Please try again.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/agreements?user_external_id=&status=CREATED&agreement_type=&start_date=&end_date=&size=20&page=0", "host": [ "{{baseUrl}}" ], "path": [ "agreements" ], "query": [ { "description": "(Required) ", "key": "user_external_id", "value": "" }, { "key": "status", "value": "CREATED" }, { "key": "agreement_type", "value": "" }, { "description": "(Required) ", "key": "start_date", "value": "" }, { "description": "(Required) ", "key": "end_date", "value": "" }, { "key": "size", "value": "20" }, { "key": "page", "value": "0" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-778a6c2b-af0f-4aac-939a-efc50f597bf0" } ], "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-ba9d5286-e578-40ca-af0a-d7376b49d1b0" } ], "id": "e22e1b77-9c4c-43c5-a2b9-ec308c4bab44", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-e22e1b77-9c4c-43c5-a2b9-ec308c4bab44" }, { "name": "payment_requests", "item": [ { "name": "{payment_request_uuid}", "item": [ { "name": "Get PayTo Payment Initiation Request Details", "id": "fe38a959-ac81-4850-8524-2c93f9ea5882", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/payment_requests/:payment_request_uuid", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", ":payment_request_uuid" ], "variable": [ { "id": "99407048-5e5e-49d9-9a4c-0c046b7885ae", "key": "payment_request_uuid", "value": "", "description": "(Required) " } ] }, "description": "This operation is to retrieve details of an initiated payment request. This API should be invoked to know the latest status of the payment initiation request if needed.\n\n Payment initiation request statuses which will be returned via this endpoint -\n- PENDING_PAYMENT_INITIATION - when the payment initiation request has been accepted for processing \n- PAYMENT_INITIATED - when the payment initiation request is being processed \n- PAYMENT_INITIATION_COMPLETED - when the payment initiation request is cleared and settled successfully. Funds can be expected in the user's wallet soon \n- PAYMENT_INITIATION_REJECTED - when the payment initiation request is rejected for processing due to validation, funds not available in the debtor's account or any other \nbusiness reason. A retry can be performed in such scenarios" }, "response": [ { "id": "3fa65498-dabd-4c49-9287-fbb1ba0f1d4f", "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_requests/:payment_request_uuid", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", ":payment_request_uuid" ], "variable": [ { "key": "payment_request_uuid" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payment_request_uuid\": \"\",\n \"instruction_id\": \"\",\n \"agreement_uuid\": \"\",\n \"agreement_id\": \"\",\n \"status\": \"PAYMENT_INITIATED\",\n \"status_description\": \"\",\n \"status_reason_code\": \"\",\n \"status_reason_description\": \"\",\n \"payment_reconciled\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_info\": {\n \"instruction_id\": \"\",\n \"instructed_amount\": \"\",\n \"last_payment\": false,\n \"end_to_end_id\": \"\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n },\n \"retry_attempts\": {\n \"count\": \"\",\n \"retry_info\": [\n {\n \"instruction_id\": \"\",\n \"status\": \"PAYMENT_REJECTED\",\n \"status_description\": \"\",\n \"status_reason_code\": \"\",\n \"status_reason_description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_info\": {\n \"instruction_id\": \"\",\n \"instructed_amount\": \"\",\n \"last_payment\": false,\n \"end_to_end_id\": \"\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n }\n },\n {\n \"instruction_id\": \"\",\n \"status\": \"PAYMENT_REJECTED\",\n \"status_description\": \"\",\n \"status_reason_code\": \"\",\n \"status_reason_description\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"payment_info\": {\n \"instruction_id\": \"\",\n \"instructed_amount\": \"\",\n \"last_payment\": false,\n \"end_to_end_id\": \"\",\n \"remittance_info\": \"\",\n \"unique_superannuation_id\": \"\",\n \"unique_superannuation_code\": \"\"\n }\n }\n ]\n }\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-3fa65498-dabd-4c49-9287-fbb1ba0f1d4f" }, { "id": "5d3691b8-25b6-4c0d-85cc-00a901af85ce", "name": "Unauthorised \n
Error CodeError Message
PAYT-ERR-1000Invalid or missing authorisation token.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_requests/:payment_request_uuid", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", ":payment_request_uuid" ], "variable": [ { "key": "payment_request_uuid" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-5d3691b8-25b6-4c0d-85cc-00a901af85ce" }, { "id": "51fa80d7-5217-4c19-99c5-fbf3c3a44914", "name": "Forbidden \n
Error CodeError Message
PAYT-ERR-1001PayTo feature not available.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_requests/:payment_request_uuid", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", ":payment_request_uuid" ], "variable": [ { "key": "payment_request_uuid" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-51fa80d7-5217-4c19-99c5-fbf3c3a44914" }, { "id": "851fb60f-e800-49ed-98a3-61c7db64c274", "name": "Not Found \n
Error CodeError Message
PAYT-ERR-2600Payment request with provided uuid does not exist.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_requests/:payment_request_uuid", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", ":payment_request_uuid" ], "variable": [ { "key": "payment_request_uuid" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-851fb60f-e800-49ed-98a3-61c7db64c274" }, { "id": "4ae624bd-22e2-4b4f-ac52-985d543e70b3", "name": "Internal Server Error \n
Error CodeError Message
PAYT-ERR-1003An error occurred processing your request. Please try again.
", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/payment_requests/:payment_request_uuid", "host": [ "{{baseUrl}}" ], "path": [ "payment_requests", ":payment_request_uuid" ], "variable": [ { "key": "payment_request_uuid" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n {\n \"error_code\": \"\",\n \"error_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-4ae624bd-22e2-4b4f-ac52-985d543e70b3" } ], "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-fe38a959-ac81-4850-8524-2c93f9ea5882" } ], "id": "f30af0c0-80ae-4f2e-b8fe-491b26f58c3c", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-f30af0c0-80ae-4f2e-b8fe-491b26f58c3c" } ], "id": "cab5a769-e6a8-4c2c-a14a-a9cbf9dee9ac", "createdAt": "2026-07-28T03:36:53.000Z", "updatedAt": "2026-07-28T03:36:53.000Z", "uid": "35240-cab5a769-e6a8-4c2c-a14a-a9cbf9dee9ac" } ], "variable": [ { "key": "baseUrl", "value": " https://au-0000.api.assemblypay.com/payto/" } ] }