How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zai

Zai PayTo Agreements API

Agreement Management APIs

Documentation Provider Profile APIs.io OpenAPI GitHub

Zai PayTo Agreements API is one of 26 APIs that Zai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include PayTo Agreements. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 7 operations across 7 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, 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.

7 operations 7 paths 47 schemas 2 GET3 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.4-external
Base URL
https://secure.api.promisepay.com
Authentication
HTTP Bearer
Contact
Zai
Resource Areas
1

Authentication & Security 1

Zai PayTo Agreements API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 2 GET, 3 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

PayTo Agreements 7

Agreement Management APIs

POST
/agreements/{agreement_uuid}/create
Create PayTo Agreement
createAgreement 1 param → 401403404202400410500
POST
/agreements/validate
Validate PayTo Agreement
validateAgreement body → 401202500400403404
PATCH
/agreements/{agreement_uuid}/status
Amend PayTo Agreement Status
amendAgreementStatus 1 param body → 401409202400403500404
PATCH
/agreements/{agreement_uuid}/recall
Recall PayTo Agreement
recallAgreementAction 1 param → 401404403400202500
PATCH
/agreements/{agreement_uuid}/amend
Amend PayTo Agreement Details
amendAgreementDetails 1 param body → 401400403409500202404
GET
/agreements/{agreement_uuid}
Get PayTo Agreement Details
getAgreementDetails 1 param → 400401500200403404
GET
/agreements
Get All PayTo Agreements for a User
getAgreementsByUser 7 params → 400401500403200

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are AgreementInfo (13 properties), AgreementInformation (12 properties), AgreementDetailsResponse (9 properties), AmendPaymentTermsDetails (8 properties). Each schema is shown below with its type and property counts.

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
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
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
DebtorAccountPayidInformation
object
Debtor account PayID Details. Property descriptions: - payidtype - PayID type associated with Debtor's bank account. Supported values: - EMAL - Email Address -…
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
DebtorAccountDetails
object
Debtor Account Details. Property descriptions: - accountid - Debtor's actual bank account number (BSB + Account Number). - accountidtype - Debtor's bank accoun…
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
BilateralAmendments
object
Specific characteristics about the bilateral fields. Specifies fields for which amendments are effective only post debtor authorisation. Property descriptions:…
4 properties
CreditorInfo
object
Information concerning the creditor party identified in the agreement. Property descriptions: - creditoraccountdetails - Information containing creditor accoun…
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
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
DebtorInformation
object
Debtor and Debtor Account Details. Property descriptions: - debtoraccountdetails - Debtor Account Details. - debtordetails - Debtor Details.
2 properties 2 required
PaymentInitiatorInfo
object
Initiating party details. Property descriptions: - initiatorid - Unique and unambiguous identification of the initiator. - initiatoridtypecode - Code indicatin…
4 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
AmendAgreementDetailsResponse
object
Specific characteristics of an agreement details amendment response.
5 properties
AgreementInfo
object
Details (creditor, debtor, payment terms) which should be agreed between debtor and creditor. Property descriptions: - agreementid - Unique agreement identifie…
13 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
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
RecallAgreementActionResponse
object
1 property
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
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
AgreementDetailsResponse
object
Definition of the agreement details response. Property descriptions: - agreementuuid - Unique ID, used to unambiguously identify the agreement. - userexternali…
9 properties
DebtorInfo
object
Debtor and Debtor Account Details. Property descriptions: - debtoraccountdetails - Debtor Account Details. - debtordetails - Debtor Details.
2 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
AgreementListResponse
object
List of agreement details.
2 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
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
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
CreateAgreementResponse
object
4 properties
CreditorAccountDetails
object
Creditor Account Details. Property descriptions: - accountid - Creditor's actual bank account number (BSB + Account Number). - accountidtype - Specifies the ac…
2 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
ErrorDetails
object
2 properties
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
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
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
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
PayToErrorResponse
object
1 property
AmendPaymentInitiatorInformation
object
Initiating party details. Property descriptions: - initiatorid - Unique and unambiguous identification of the initiator. - initiatoridtypecode - Code indicatin…
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
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
DebtorAccountPayidDetails
object
Debtor account PayID Details. Property descriptions: - payidtype - PayID type associated with Debtor's bank account. Supported values: - EMAL - Email Address -…
3 properties
ValidateAgreementResponse
object
4 properties
AmendAgreementStatusResponse
object
Specific characteristics of an agreement status amendment response.
5 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
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
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
AmendCreditorInformation
object
Information concerning the creditor party identified in the agreement. Property descriptions: - ultimatecreditorname - This field can indicate trading the name…
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zai-payto-agreements-api-openapi.yml Raw ↑

Other APIs Zai publishes across the network.

Zai Addresses API
AE Profile APIs.io
Zai Authentication API
AE Profile APIs.io
Zai Bank Accounts API
AE Profile APIs.io
Zai Batch Transactions API
AE Profile APIs.io
Zai BPay Accounts API
AE Profile APIs.io
Zai Callbacks API
AE Profile APIs.io
Zai Card Accounts API
AE Profile APIs.io
Zai Charges API
AE Profile APIs.io
Zai Companies API
AE Profile APIs.io
Zai Direct Debit Authorities API
AE Profile APIs.io
Zai Disbursements API
AE Profile APIs.io
Zai Fees API
AE Profile APIs.io
#PayTo Agreements
← Back to Z APIs
API Details
ID
zai:zai-payto-agreements-api
Base URL
https://secure.api.promisepay.com
Docs
https://developer.hellozai.com/reference/overview
Provider
Zai
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zai-payto-agreements-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zai-payto-agreements-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Zai PayTo Agreements API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.