Add a Receivable Contact

post

https://api.sandbox.zeptopayments.com/contacts/receivable

Receive funds from a Contact by allowing them to pay to a personalised PayID or account number. Perfect for reconciling incoming funds to a customer, receiving funds instantly, eliminating human error & improving your customer's experience.

There are two strategies supported for PayID assignment when creating this type of Contact:

On-demand PayID: provide a payid_email and we'll create a contact and register a PayID with the given email address. The PayID registration process happens when the request is received. The initial response for payid_details.state will always be pending. It will transition to active when the PayID registration process is complete. This can take up to a few seconds. You can use webhooks to be informed of this state change.

Pooled PayID: provide your payid_email_domain and we'll create a contact and assign them a PayID from your pool. Pooled PayIDs are pre-registered. The PayID email value is generated using a random value and the email domain from your PayID pool configuration. Providing both payid_email and payid_email_domain will ignore your pool and use the "On-demand PayID" strategy instead.

Receivable Contacts for your clients: with the "On-demand PayID" strategy you can supply the optional client_id of a client registered via the Clients API. Zepto registers the Contact's float account and PayID under that client, and payers see the client's legal name in PayID and Confirmation of Payee (CoP) resolutions. To show one of the client's registered business names instead, supply it as payid_name. Without a client_id supplied, payers see the default payid_name supplied during onboarding. Pooled PayIDs ignore client_id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length between 3 and 140

^[ -~]+$

Contact name (Min: 3 - Max: 140)

string

required

length between 6 and 256

Contact email (Min: 6 - Max: 256)

payid_email

string

length between 6 and 256

Contact PayID email (Min: 6 - Max: 256)

payid_email_domain

string

length between 3 and 254

PayID pool email domain (Min: 3 - Max: 254)

client_id

uuid

Client to register the Contact's PayID and float account under. On-demand PayID strategy only. The client must have active RTP service.

payid_name

string

length between 1 and 140

The name shown to payers in PayID and Confirmation of Payee resolutions. Customisation requires an accompanying client_id and must match the supplied client's legal name or one of its business names.

Headers

Zepto-API-Version

string

^\d{8}$

Defaults to 20250101

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

Responses

404

Not Found

201Created

400Bad Request (errors)