Zai PayTo API
Create and manage PayTo agreements (mandated real-time debits) and initiate payments against them over the New Payments Platform. OpenAPI 3.0.1, version 1.4-external, 10 documented paths, secured with bearer-token authentication.
Zai PayTo API is one of 4 APIs that Zai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include PayTo, Mandates, NPP, Direct Debit, and Real-Time Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 10 operations across 10 paths, organized into 2 resource areas, and defines 56 schemas. It is described by OpenAPI 3.0.1, at version 1.4-external.
Requests are made against 3 base URLs: https://au-0000.api.assemblypay.com/payto/, https://sandbox.au-0000.api.assemblypay.com/payto/, https://virtserver.swaggerhub.com/AssemblyPlatforms/PayTo/1.4-external.
10 operations
10 paths
56 schemas
4 GET3 PATCH3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zai PayTo API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
Paths & Operations 10
Across 10 paths, the API surfaces 10 operations — 4 GET, 3 PATCH, 3 POST. They span 2 resource areas: PayTo Payments, PayTo Agreements. Each is listed below with its method, path, parameters, and response codes.
PayTo Payments 3
Payment Initiation APIs
POST
/agreements/{agreement_uuid}/payment_requests/initiate
Initiate PayTo Payment
GET
/payment_requests/{payment_request_uuid}
Get PayTo Payment Initiation Request Details
GET
/agreements/{agreement_uuid}/payment_requests
Get All PayTo Payment Initiation Requests for an Agreement
PayTo Agreements 7
Agreement Management APIs
POST
/agreements/{agreement_uuid}/create
Create PayTo Agreement
POST
/agreements/validate
Validate PayTo Agreement
PATCH
/agreements/{agreement_uuid}/status
Amend PayTo Agreement Status
PATCH
/agreements/{agreement_uuid}/recall
Recall PayTo Agreement
PATCH
/agreements/{agreement_uuid}/amend
Amend PayTo Agreement Details
GET
/agreements/{agreement_uuid}
Get PayTo Agreement Details
GET
/agreements
Get All PayTo Agreements for a User
Schemas 56
The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are AgreementInfo (13 properties), InitiatePaymentStatusResponse (13 properties), AgreementInformation (12 properties), AgreementDetailsResponse (9 properties). Each schema is shown below with its type and property counts.
InitiatePaymentRequest
object
Definition of the Initiate Payment request data. Property descriptions: - priority - Indicates payment processing priority. Supported values: - Attended: Payme…
3 properties
2 required
PaymentInformation
object
Payment request details. Property descriptions: - instructedamount - Specifies the amount to be debited the from debtor's bank account before deduction of char…
6 properties
2 required
RetryInformation
object
Retry information should be provided only if the payment request was rejected previously due to business reasons and a retry for the same is being attempted. P…
1 property
ErrorDetails
object
2 properties
PayToErrorResponse
object
1 property
InitiatePaymentResponse
object
7 properties
CreateAgreementResponse
object
4 properties
AgreementInformation
object
Details (creditor, debtor, payment terms) which should be agreed between debtor and creditor. Property descriptions: - description - Describes what the agreeme…
12 properties
7 required
CreditorInformation
object
Creditor Details. Property descriptions: - ultimatecreditorname - This field can indicate trading the name or common name of the marketplace/platform which is…
2 properties
1 required
DebtorAccountInformation
object
Debtor Account Details. Property descriptions: - accountidtype - Debtor's bank account type. Supported values: - BBAN (bsb/account) - PAYID (PayID) - accountid…
3 properties
1 required
DebtorAccountPayidInformation
object
Debtor account PayID Details. Property descriptions: - payidtype - PayID type associated with Debtor's bank account. Supported values: - EMAL - Email Address -…
2 properties
DebtorInformation
object
Debtor and Debtor Account Details. Property descriptions: - debtoraccountdetails - Debtor Account Details. - debtordetails - Debtor Details.
2 properties
2 required
DebtorInformationDetails
object
Debtor Details. Property descriptions: - debtorname - Specifies the name by which the debtor is known and which is usually used to identify that debtor. - debt…
6 properties
3 required
FirstPaymentInformation
object
If the payment arrangement is such that the initial payment amount differs from the expected "regular" or "recurring" payment, then the first payment info can…
3 properties
LastPaymentInformation
object
If the payment arrangement is such that there is a known final payment amount that differs from the expected "regular" or "recurring" payment, then the last pa…
3 properties
MaximumAmountInformation
object
Represents the maximum amount that may be debited in any single payment initiation. Property descriptions: - amount - For FIXE type of agreements, as the amoun…
2 properties
PaymentAmountInformation
object
Specifies info around the amount type for the agreement (example: Fixed or Usage based amounts etc), amount that can be debited from the account depending on t…
3 properties
PaymentInitiatorInformation
object
Initiating party details. Your platform name or any third party name that you prefer to be shown to the debtor as initiator of the payments. Example - If it’s…
4 properties
4 required
PaymentTermsDetails
object
Specifies payment terms for the agreement i.e. amount that can be debited per payment, min/max amounts, first and last payment terms etc. All the payments init…
8 properties
2 required
ValidateAgreementRequest
object
Definition of the agreement validation request data. Property descriptions: - userexternalid - Unique id of the user (created via [Create User](https://develop…
4 properties
3 required
ValidateAgreementResponse
object
4 properties
AmendAgreementStatusRequest
object
Request to change the status of an agreement. Property descriptions: - status - Expected status of the agreement post amendment. - reasoncode - Reason for stat…
3 properties
1 required
AmendAgreementStatusResponse
object
Specific characteristics of an agreement status amendment response.
5 properties
RecallAgreementActionResponse
object
1 property
AmendAgreementDetailsRequest
object
Request to amend the details of an agreement. Property descriptions: - priority - Priority of the agreement amendment authorisation notification to be sent to…
4 properties
1 required
AmendCreditorInformation
object
Information concerning the creditor party identified in the agreement. Property descriptions: - ultimatecreditorname - This field can indicate trading the name…
2 properties
AmendFirstPaymentInformation
object
If the payment arrangement is such that the initial payment amount differs from the expected "regular" or "recurring" payment, then the first payment info can…
3 properties
AmendLastPaymentInformation
object
If the payment arrangement is such that there is a known final payment amount that differs from the expected "regular" or "recurring" payment, then the last pa…
3 properties
AmendMaximumAmountInformation
object
Represents the maximum amount that may be debited in any single payment initiation. Property descriptions: - amount - For FIXE type of agreements, as the amoun…
2 properties
AmendPaymentAmountInformation
object
Specifies info around the amount type for the agreement (example: Fixed or Usage based amounts etc), amount that can be debited from the account depending on t…
3 properties
AmendPaymentInitiatorInformation
object
Initiating party details. Property descriptions: - initiatorid - Unique and unambiguous identification of the initiator. - initiatoridtypecode - Code indicatin…
4 properties
AmendPaymentTermsDetails
object
Specifies payment terms for the agreement i.e. amount that can be debited per payment, min/max amounts, first and last payment terms etc. All the payments init…
8 properties
BilateralAmendments
object
Specific characteristics about the bilateral fields. Specifies fields for which amendments are effective only post debtor authorisation. Property descriptions:…
4 properties
UnilateralAmendments
object
Specific characteristics about the unilateral fields. Specifies fields for which amendments are effective immediately and do not require debtor authorisation.…
4 properties
AmendAgreementDetailsResponse
object
Specific characteristics of an agreement details amendment response.
5 properties
InitiatePaymentStatusResponse
object
Definition of PayTo Payment Details. Property descriptions: - paymentrequestuuid - Unique identifier for the payment request in UUID format. - instructionid -…
13 properties
PaymentInfo
object
Payment Request details. Property descriptions: - instructionid - Unique identifier for the payment request generated as per NPPA guidelines. This identifier i…
7 properties
RetryAttempts
object
List of retry attempts for the payment request. Property descriptions: - count - Payment retry count. - retryinfo - Payment information for each retry attempt,…
2 properties
RetryInfo
object
Payment information for each retry attempt. Property descriptions: - instructionid - Unique identifier for the payment request generated as per NPPA guidelines…
8 properties
InitiatePaymentListResponse
object
List of Initiate Payment Status details.
2 properties
AgreementDetailsResponse
object
Definition of the agreement details response. Property descriptions: - agreementuuid - Unique ID, used to unambiguously identify the agreement. - userexternali…
9 properties
AgreementInfo
object
Details (creditor, debtor, payment terms) which should be agreed between debtor and creditor. Property descriptions: - agreementid - Unique agreement identifie…
13 properties
CreditorAccountDetails
object
Creditor Account Details. Property descriptions: - accountid - Creditor's actual bank account number (BSB + Account Number). - accountidtype - Specifies the ac…
2 properties
CreditorDetails
object
Information concerning the creditor party identified in the agreement. Property descriptions: - creditorid - Unique and unambiguous identification of the credi…
6 properties
CreditorInfo
object
Information concerning the creditor party identified in the agreement. Property descriptions: - creditoraccountdetails - Information containing creditor accoun…
2 properties
DebtorAccountDetails
object
Debtor Account Details. Property descriptions: - accountid - Debtor's actual bank account number (BSB + Account Number). - accountidtype - Debtor's bank accoun…
3 properties
DebtorAccountPayidDetails
object
Debtor account PayID Details. Property descriptions: - payidtype - PayID type associated with Debtor's bank account. Supported values: - EMAL - Email Address -…
3 properties
DebtorDetails
object
Debtor Details. Property descriptions: - debtorname - Specifies the name by which the debtor is known and which is usually used to identify that debtor. - debt…
6 properties
DebtorInfo
object
Debtor and Debtor Account Details. Property descriptions: - debtoraccountdetails - Debtor Account Details. - debtordetails - Debtor Details.
2 properties
FirstPaymentInfo
object
If the payment arrangement is such that the initial payment amount differs from the expected "regular" or "recurring" payment, then the first payment info can…
3 properties
LastPaymentInfo
object
If the payment arrangement is such that there is a known final payment amount that differs from the expected "regular" or "recurring" payment, then the last pa…
3 properties
MaximumAmountInfo
object
Represents the maximum amount that may be debited in any single payment initiation. Property descriptions: - amount - For FIXE type of agreements, as the amoun…
2 properties
PaymentAmountInfo
object
Specifies info around the amount type for the agreement (example: Fixed or Usage based amounts etc), amount that can be debited from the account depending on t…
3 properties
PaymentInitiatorInfo
object
Initiating party details. Property descriptions: - initiatorid - Unique and unambiguous identification of the initiator. - initiatoridtypecode - Code indicatin…
4 properties
PaymentTerms
object
Specifies payment terms for the agreement i.e. amount that can be debited per payment, min/max amounts, first and last payment terms etc. All the payments init…
8 properties
AgreementListResponse
object
List of agreement details.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zai 3
Other APIs Zai publishes across the network.
Zai Assembly API
Zai Virtual Accounts and PayIDs API
Zai Asynchronous API
#PayTo#Mandates#NPP#Direct Debit#Real-Time Payments