Zepto PayTo API
Programmatic PayTo mandate management and real-time collection — create, amend, suspend, reactivate and cancel PayTo agreements, then collect authorised real-time payments and issue refunds against them. Zepto is a Connected Institution to the NPP for PayTo.
Zepto PayTo API is one of 7 APIs that Zepto publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include PayTo, Agreements, Mandates, and Real-Time Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 19 operations across 15 paths, organized into 5 resource areas, and defines 126 schemas. It is described by OpenAPI 3.0.1, at version 20260101.
Requests are made against 2 base URLs: https://api.sandbox.zeptopayments.com, https://api.zeptopayments.com.
19 operations
15 paths
126 schemas
8 GET11 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zepto PayTo API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 19
Across 15 paths, the API surfaces 19 operations — 8 GET, 11 POST. They span 5 resource areas: Agreements, Agreement modification, Alias Resolution, Payments, Refunds (Beta). Each is listed below with its method, path, parameters, and response codes.
Agreements 4
Create and query agreements
POST
/payto/agreements
create agreement
GET
/payto/agreements
list agreements
GET
/payto/agreements/{agreement_uid}
show agreement
GET
/payto/agreements/{agreement_uid}/history
list agreement history
Agreement modification 7
Modify existing agreements
POST
/payto/agreements/{agreement_uid}/amendment
create amendment
GET
/payto/agreements/{agreement_uid}/amendment
show amendment
POST
/payto/agreements/{agreement_uid}/amendment/recall
create amendmentrecall
POST
/payto/agreements/{agreement_uid}/cancellation
cancel agreement
POST
/payto/agreements/{agreement_uid}/suspension
suspend agreement
POST
/payto/agreements/{agreement_uid}/reactivation
reactivate agreement
POST
/payto/agreements/{agreement_uid}/simulate_debtor_action
simulate debtor [sandbox]
Alias Resolution 1
Resolve the display name associated with a PayID alias
POST
/payto/alias_resolution
resolve
Payments 4
Make payments using an existing agreement
POST
/payto/payments
create payment
GET
/payto/payments
list payments
GET
/payto/payments/{payment_uid}
show payment
POST
/payto/payments/{payment_uid}/retry
retry payment
Refunds (Beta) 3
Refund existing settled PayTo Payments Beta Release We're excited to announce that this feature is now in beta! While we'll aim to minimize breaking changes, some adjustments may…
POST
/payto/refunds
create refund
GET
/payto/refunds
list refunds
GET
/payto/refunds/{refund_uid}
show refund
Schemas 126
The contract defines 126 schemas that model the data the API accepts and returns. The most detailed are payto.agreement (18 properties), payto.payment (16 properties), payto.agreement_request (13 properties), payto.payment_request (12 properties). Each schema is shown below with its type and property counts.
payto.account_identifier
object
An identifier representing the parties account
2 properties
2 required
payto.account_identifiers_alias_abn
string
A PayID ABN alias
payto.account_identifiers_alias_email
string
A PayID email alias
payto.account_identifiers_alias_organisation_identifier
string
A PayID organisation identifier alias
payto.account_identifiers_alias_phone
string
A PayID phone alias. e.g. +61-411222333
payto.account_identifiers_bban
string
A branch code (BSB) and account number separated with a hyphen
payto.account_number
string
A bank account number
payto.agreement
object
18 properties
17 required
payto.agreement_request
object
13 properties
5 required
payto.alias_resolution
object
1 property
1 required
payto.alias_resolution_abn_request
payto.alias_resolution_base_request
object
2 properties
1 required
payto.alias_resolution_email_request
payto.alias_resolution_organisation_request
payto.alias_resolution_phone_request
payto.alias_resolution_request
object
payto.alias_resolution_service_unavailable_error
object
5 properties
3 required
payto.alias_resolution_service_unavailable_errors
object
1 property
1 required
payto.amendment
object
8 properties
8 required
payto.amendment_recall
object
6 properties
6 required
payto.amendment_recall_request
object
1 property
payto.amendment_request
object
3 properties
1 required
payto.amount
integer
Amount in cents.
payto.branch_code
string
A 6-digit BSB
payto.cancellation_request
object
3 properties
1 required
payto.event.agreement_action_failed
object
1 property
payto.event.base
object
6 properties
6 required
payto.event.payto_agreement.activated
payto.event.payto_agreement.amended
payto.event.payto_agreement.amendment_declined
payto.event.payto_agreement.amendment_expired
payto.event.payto_agreement.amendment_failed
payto.event.payto_agreement.amendment_recall_failed
payto.event.payto_agreement.amendment_recalled
payto.event.payto_agreement.cancellation_failed
payto.event.payto_agreement.cancelled
payto.event.payto_agreement.declined
payto.event.payto_agreement.expired
payto.event.payto_agreement.failed
payto.event.payto_agreement.reactivated
payto.event.payto_agreement.reactivation_failed
payto.event.payto_agreement.suspended
payto.event.payto_agreement.suspension_failed
payto.event.payto_payment.failed
payto.event.payto_payment.pending
payto.event.payto_payment.settled
payto.event.payto_payment.under_investigation
payto.event.payto_refund.failed
payto.event.payto_refund.processed
payto.event.resource_metadata
object
1 property
6 required
payto.generic_error
object
4 properties
2 required
payto.generic_errors
object
1 property
1 required
payto.initiator_with_abn
object
3 properties
3 required
payto.initiator_with_acn
object
3 properties
3 required
payto.metadata
object
Use for your custom data. A place to store any miscellaneous information your system may need in regards to the record you are creating. This will be included…
payto.pagination_links
object
1 property
payto.payment
object
16 properties
15 required
payto.payment_failure
object
Details about the payment failure, when the state is 'failed'
4 properties
4 required
payto.payment_request
object
12 properties
4 required
payto.payment_terms_balloon
object
An agreement that supports a balloon amount for first and last payments.
8 properties
3 required
payto.payment_terms_fixed
object
An agreement that supports payments for a given fixed amount only
6 properties
3 required
payto.payment_terms_usage_based
object
An agreement that supports payments based on usage up to an optional max amount
6 properties
2 required
payto.payment_terms_variable
object
An agreement that supports variable payments based up to an optional max amount
6 properties
2 required
payto.reactivation_request
object
1 property
payto.reason
object
Details about the reason for the resource being in its current state
3 properties
3 required
payto.refund.float_bank_payment
object
4 properties
4 required
payto.refund.pay_to_payment
object
5 properties
3 required
payto.refund
object
8 properties
7 required
payto.refund_failure
object
Details about the refund failure, when the state is 'failed'
3 properties
3 required
payto.refund_request
object
5 properties
3 required
payto.retry_payment_request
object
2 properties
payto.simulate_debtor_action_request
object
payto.simulate_debtor_amendment_request
object
2 properties
2 required
payto.simulate_debtor_cancellation_request
object
3 properties
2 required
payto.simulate_debtor_reactivation_request
object
1 property
1 required
payto.simulate_debtor_suspension_request
object
3 properties
2 required
payto.suspension_request
object
3 properties
1 required
payto.unprocessable_alias_resolution_error
object
5 properties
3 required
payto.unprocessable_alias_resolution_errors
object
1 property
1 required
payto.unprocessable_amendment_error
object
5 properties
3 required
payto.unprocessable_amendment_errors
object
1 property
1 required
payto.unprocessable_amendment_recall_error
object
5 properties
3 required
payto.unprocessable_amendment_recall_errors
object
1 property
1 required
payto.unprocessable_error
object
5 properties
3 required
payto.unprocessable_errors
object
1 property
1 required
payto.unprocessable_mandate_cancel_error
object
5 properties
3 required
payto.unprocessable_mandate_cancel_errors
object
1 property
1 required
payto.unprocessable_mandate_error
object
5 properties
3 required
payto.unprocessable_mandate_errors
object
1 property
1 required
payto.unprocessable_mandate_reactivate_error
object
5 properties
3 required
payto.unprocessable_mandate_reactivate_errors
object
1 property
1 required
payto.unprocessable_mandate_simulate_debtor_action_error
object
5 properties
3 required
payto.unprocessable_mandate_simulate_debtor_action_errors
object
1 property
1 required
payto.unprocessable_mandate_suspend_error
object
5 properties
3 required
payto.unprocessable_mandate_suspend_errors
object
1 property
1 required
payto.unprocessable_pagination_error
object
5 properties
3 required
payto.unprocessable_pagination_errors
object
1 property
1 required
payto.unprocessable_payment_error
object
5 properties
3 required
payto.unprocessable_payment_errors
object
1 property
1 required
payto.unprocessable_payment_retry_error
object
5 properties
3 required
payto.unprocessable_payment_retry_errors
object
1 property
1 required
payto.unprocessable_refund_error
object
5 properties
3 required
payto.unprocessable_refund_errors
object
1 property
1 required
payto.webhook.base
object
2 properties
2 required
payto.webhook.payto_agreement.activated
payto.webhook.payto_agreement.amended
payto.webhook.payto_agreement.amendment_declined
payto.webhook.payto_agreement.amendment_expired
payto.webhook.payto_agreement.amendment_failed
payto.webhook.payto_agreement.amendment_recall_failed
payto.webhook.payto_agreement.amendment_recalled
payto.webhook.payto_agreement.cancellation_failed
payto.webhook.payto_agreement.cancelled
payto.webhook.payto_agreement.declined
payto.webhook.payto_agreement.expired
payto.webhook.payto_agreement.failed
payto.webhook.payto_agreement.reactivated
payto.webhook.payto_agreement.reactivation_failed
payto.webhook.payto_agreement.suspended
payto.webhook.payto_agreement.suspension_failed
payto.webhook.payto_payment.failed
payto.webhook.payto_payment.pending
payto.webhook.payto_payment.settled
payto.webhook.payto_payment.under_investigation
payto.webhook.payto_refund.failed
payto.webhook.payto_refund.processed
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zepto 6
Other APIs Zepto publishes across the network.
Zepto API
Zepto Validate API (Confirmation of Payee)
Zepto Investigations API
Zepto Clients API
Zepto Merchant Reports API
Zepto Notifications API (Webhooks)
#PayTo#Agreements#Mandates#Real-Time Payments