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

Zepto Agreement modification API

Modify existing agreements

Zepto Agreement modification API is one of 22 APIs that Zepto publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agreement modification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 6 paths, and defines 59 schemas. It is described by OpenAPI 3.2.0, at version 20260101.

Requests are made against 2 base URLs: https://api.sandbox.zeptopayments.com, https://api.zeptopayments.com.

7 operations 6 paths 59 schemas 1 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20260101
Base URL
https://api.zeptopayments.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Zepto Agreement modification API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 7

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

Agreement modification 7

Modify existing agreements

POST
/payto/agreements/{agreement_uid}/amendment
create amendment
2 params body → 202400422401403404500
GET
/payto/agreements/{agreement_uid}/amendment
show amendment
2 params → 200401403404500
POST
/payto/agreements/{agreement_uid}/amendment/recall
create amendmentrecall
2 params body → 202422401403500
POST
/payto/agreements/{agreement_uid}/cancellation
cancel agreement
2 params body → 202400422401403404500
POST
/payto/agreements/{agreement_uid}/suspension
suspend agreement
2 params body → 202400422401403404500
POST
/payto/agreements/{agreement_uid}/reactivation
reactivate agreement
2 params body → 202400422401403404500
POST
/payto/agreements/{agreement_uid}/simulate_debtor_action
simulate debtor [sandbox]
2 params body → 202400422401403404500

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are payto.amendment (8 properties), payto.event.base (6 properties), payto.unprocessable_mandate_cancel_error (5 properties), payto.unprocessable_mandate_suspend_error (5 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.unprocessable_mandate_simulate_debtor_action_errors
object
1 property 1 required
payto.unprocessable_mandate_reactivate_errors
object
1 property 1 required
payto.event.payto_agreement.reactivation_failed
payto.webhook.payto_agreement.suspension_failed
payto.simulate_debtor_suspension_request
object
3 properties 2 required
payto.simulate_debtor_amendment_request
object
2 properties 2 required
payto.webhook.payto_agreement.cancellation_failed
payto.event.payto_agreement.amendment_failed
payto.webhook.payto_agreement.reactivated
payto.event.payto_agreement.amendment_recalled
payto.unprocessable_amendment_recall_error
object
5 properties 3 required
payto.account_identifiers_alias_abn
string
A PayID ABN alias
payto.webhook.payto_agreement.amendment_expired
payto.amendment_recall_request
object
1 property
payto.webhook.base
object
2 properties 2 required
payto.webhook.payto_agreement.amendment_declined
payto.unprocessable_amendment_recall_errors
object
1 property 1 required
payto.webhook.payto_agreement.amendment_failed
payto.account_identifiers_alias_phone
string
A PayID phone alias. e.g. +61-411222333
payto.unprocessable_mandate_reactivate_error
object
5 properties 3 required
payto.reactivation_request
object
1 property
payto.event.payto_agreement.cancelled
payto.event.base
object
6 properties 6 required
payto.event.payto_agreement.amendment_expired
payto.event.payto_agreement.amendment_declined
payto.event.payto_agreement.amended
payto.webhook.payto_agreement.cancelled
payto.account_identifiers_alias_email
string
A PayID email alias
payto.simulate_debtor_reactivation_request
object
1 property 1 required
payto.cancellation_request
object
3 properties 1 required
payto.unprocessable_mandate_error
object
5 properties 3 required
payto.suspension_request
object
3 properties 1 required
payto.webhook.payto_agreement.amendment_recall_failed
payto.unprocessable_mandate_suspend_errors
object
1 property 1 required
payto.event.agreement_action_failed
object
1 property
payto.webhook.payto_agreement.amended
payto.simulate_debtor_cancellation_request
object
3 properties 2 required
payto.unprocessable_mandate_cancel_errors
object
1 property 1 required
payto.simulate_debtor_action_request
object
payto.event.payto_agreement.suspension_failed
payto.event.payto_agreement.suspended
payto.reason
objectnull
Details about the reason for the resource being in its current state
3 properties 3 required
payto.generic_error
object
4 properties 2 required
payto.account_identifiers_alias_organisation_identifier
string
A PayID organisation identifier alias
payto.amendment_request
object
3 properties 1 required
payto.webhook.payto_agreement.reactivation_failed
payto.unprocessable_mandate_errors
object
1 property 1 required
payto.event.payto_agreement.amendment_recall_failed
payto.event.payto_agreement.cancellation_failed
payto.amendment
object
8 properties 8 required
payto.unprocessable_mandate_simulate_debtor_action_error
object
5 properties 3 required
payto.account_identifiers_bban
string
A branch code (BSB) and account number separated with a hyphen
payto.webhook.payto_agreement.suspended
payto.generic_errors
object
1 property 1 required
payto.webhook.payto_agreement.amendment_recalled
payto.unprocessable_mandate_suspend_error
object
5 properties 3 required
payto.unprocessable_mandate_cancel_error
object
5 properties 3 required
payto.event.payto_agreement.reactivated

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zepto-payments-agreement-modification-api-openapi.yml Raw ↑

Other APIs Zepto publishes across the network.

Zepto Agreements API
Zepto Alias Resolution API
Zepto Bank Accounts API
Zepto Clients API
Zepto Contacts API
Zepto Contacts (Receivable) API
Zepto CoP Account Validations API
Zepto Disputes (Beta) API
Zepto Float Accounts API
Zepto Payment Requests API
Zepto Payments API
Zepto Payouts API
Where this information came from

This is an independent, third-party profile of Zepto Agreement modification 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.