API REFERENCE
Zepto Status PageCreate a sandbox account

create agreement

post
https://api.sandbox.zeptopayments.com/payto/agreements
Body Params
string
required
length between 1 and 64

Supplied unique identifier for agreement, maximum 64 characters containing only unreserved characters as defined in RFC3986. This identifier ensures agreement uniqueness between integrator systems and Zepto.

string
enum
required

The nature of the agreement with the debtor

debtor
object
required

Who and where the payment is taken from

creditor
object | null

Who and where the payment will be made to

initiator

The details of the party that initiated this agreement. Provide either ABN or ACN. The values provided in initiator will be ignored unless the merchant has been approved as a third-party payment processor.

string
required
length between 1 and 140

The reason for the agreement, as narrative text. ASCII-printable characters only.

date-time | null

Requested resolution (accept/decline) deadline for this agreement. It will be provided in any notification sent to the debtor. This time is for informational purposes only and does not affect the expiry time. If not provided, it defaults to 5 days from agreement creation. Value must be an ISO8601 date-time in UTC timezone.

boolean | null

An optional field to indicate whether or not Zepto should auto cancel this agreement if it is not authorized by the debtor by the resolution_requested_before point in time. This field must be accompanied by the resolution_requested_before attribute and if not, will result in a 422 response and error code.

date | null

Start date for validity of agreement. If specified, the agreement will be valid from 00:00:00 Australia Sydney time on specified date. If no date specified, the current date will be populated.

date | null

End date of the validity of the agreement. If specified, the agreement will be valid until 23:59:59.999 Australia Sydney time on this date.

metadata
object | null

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 in associated webhook payloads under the resource_metadata key. Nested values (i.e., objects and arrays) are not allowed. The maximum size of this parameter is 2kb.

payment_terms
required

Defines the terms of what payments can be initiated from agreement

sandbox
object

SANDBOX ONLY: Parameter that allows you to simulate the debtor performing certain actions against the created agreement to aid integrators while testing their control flows. Defaults to debtor_accept if not given.

Headers
string
Defaults to 20250101

API version in YYYYMMDD format. Defaults to 20250101 (legacy) when omitted.

Responses

403

forbidden

500

Internal Server Error

Callbacks

Updated 5 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago