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 Payments API

Payment Initiation APIs

Documentation Provider Profile APIs.io OpenAPI GitHub

Zai PayTo Payments 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 Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 3 operations across 3 paths, and defines 11 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.

3 operations 3 paths 11 schemas 2 GET1 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 Payments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. 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
initiatePaymentRequest 1 param body → 401403400404409500202
GET
/payment_requests/{payment_request_uuid}
Get PayTo Payment Initiation Request Details
getInitiatePaymentStatus 1 param → 401403404200500
GET
/agreements/{agreement_uuid}/payment_requests
Get All PayTo Payment Initiation Requests for an Agreement
getInitiatePaymentStatusList 6 params → 401200400500403404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are InitiatePaymentStatusResponse (13 properties), RetryInfo (8 properties), InitiatePaymentResponse (7 properties), PaymentInfo (7 properties). Each schema is shown below with its type and property counts.

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
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
InitiatePaymentListResponse
object
List of Initiate Payment Status details.
2 properties
InitiatePaymentResponse
object
7 properties
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
PaymentInfo
object
Payment Request details. Property descriptions: - instructionid - Unique identifier for the payment request generated as per NPPA guidelines. This identifier i…
7 properties
ErrorDetails
object
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
InitiatePaymentStatusResponse
object
Definition of PayTo Payment Details. Property descriptions: - paymentrequestuuid - Unique identifier for the payment request in UUID format. - instructionid -…
13 properties
InitiatePaymentRequest
object
Definition of the Initiate Payment request data. Property descriptions: - priority - Indicates payment processing priority. Supported values: - Attended: Payme…
3 properties 2 required
PayToErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zai-payto-payments-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 Payments
← Back to Z APIs
API Details
ID
zai:zai-payto-payments-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-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zai-payto-payments-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 Payments 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.