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

Create and query agreements

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

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

This API exposes 7 operations across 5 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

7 operations 5 paths 51 schemas 1 DELETE5 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Zepto Agreements 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 5 paths, the API surfaces 7 operations — 1 DELETE, 5 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Agreements 7

Create and query agreements

POST
/payto/agreements
create agreement
1 param body → 201400422401403500
GET
/payto/agreements
list agreements
7 params → 422200
GET
/payto/agreements/{agreement_uid}
show agreement
2 params → 200401403404500
GET
/payto/agreements/{agreement_uid}/history
list agreement history
4 params → 422200401403404500
GET
/agreements/outgoing
List Agreements
ListOutgoingAgreements 6 params → 200
GET
/agreements/{agreement_ref}
Get an Agreement
GetAgreement 2 params → 200
DELETE
/agreements/{agreement_ref}
Cancel an Agreement
CancelAgreement 2 params → 204

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are payto.agreement (18 properties), payto.agreement_request (13 properties), payto.payment_terms_balloon (8 properties), payto.payment_terms_variable (6 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.event.payto_agreement.reactivation_failed
payto.event.resource_metadata
object
1 property 6 required
payto.event.payto_agreement.amendment_failed
payto.event.payto_agreement.amendment_recalled
payto.account_identifiers_alias_abn
string
A PayID ABN alias
payto.event.payto_agreement.declined
payto.webhook.base
object
2 properties 2 required
payto.account_identifiers_alias_phone
string
A PayID phone alias. e.g. +61-411222333
payto.event.payto_agreement.cancelled
payto.pagination_links
object
1 property
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.account_identifiers_alias_email
string
A PayID email alias
payto.payment_terms_variable
object
An agreement that supports variable payments based up to an optional max amount
6 properties 2 required
payto.webhook.payto_agreement.expired
payto.webhook.payto_agreement.declined
payto.unprocessable_mandate_error
object
5 properties 3 required
payto.event.payto_agreement.activated
payto.event.agreement_action_failed
object
1 property
payto.initiator_with_abn
object
3 properties 3 required
payto.event.payto_agreement.expired
payto.event.payto_agreement.suspension_failed
payto.initiator_with_acn
object
3 properties 3 required
payto.event.payto_agreement.suspended
payto.account_identifiers_alias_organisation_identifier
string
A PayID organisation identifier alias
payto.generic_error
object
4 properties 2 required
payto.event.payto_agreement.failed
payto.unprocessable_pagination_error
object
5 properties 3 required
payto.webhook.payto_agreement.activated
payto.unprocessable_pagination_errors
object
1 property 1 required
payto.webhook.payto_agreement.failed
payto.agreement_request
object
13 properties 5 required
payto.unprocessable_mandate_errors
object
1 property 1 required
payto.event.payto_agreement.cancellation_failed
payto.event.payto_agreement.amendment_recall_failed
payto.agreement
object
18 properties 17 required
payto.metadata
objectnull
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.account_identifiers_bban
string
A branch code (BSB) and account number separated with a hyphen
payto.generic_errors
object
1 property 1 required
payto.payment_terms_balloon
object
An agreement that supports a balloon amount for first and last payments.
8 properties 3 required
payto.event.payto_agreement.reactivated
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_fixed
object
An agreement that supports payments for a given fixed amount only
6 properties 3 required
GetAgreementResponse
object
1 property 1 required
ListOutgoingAgreementsResponse
object
1 property 1 required
PerPayout
object
2 properties 2 required
PerFrequency
object
2 properties 2 required
Terms
object
Terms
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zepto-payments-agreements-api-openapi.yml Raw ↑

Other APIs Zepto publishes across the network.

Zepto Agreement modification 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 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.