Note: This article is relevant to merchants integrating with Zepto in Australia.
The Zepto API supports making payments from your bank or float account to any Australian bank account via BSB and Account number.
Example use cases include:
Lender disbursement of funds
Marketplace payouts
Insurance claim payouts
Fintech Apps
Making a payment is a two-step process:
1. Create a Contact
Create contact via the API
You can use the Add an Anyone Contact API Endpoint to create your contact.
POST /contacts/anyone
{
"name": "Hunter Thompson",
"email": "hunter@batcountry.com",
"branch_code": "123456",
"account_number": "13048322",
... other parameters available, see API docs
}
Invite your customer to get paid
As an alternative, you can invite your customer to get paid by sending them a special shareable link. When your customer clicks the link they are invited to enter their personal and banking details. This creates a contact within your Zepto account that you can make payment to.
2. Make a Payment
Use the Payment API Endpoint to make a payment to your contact. The endpoint supports making payments in a batch, allowing you to pay multiple contacts in one API call.
POST /payments
{
"description": "The SuperPackage",
"matures_at": "2016-09-13T00:00:00Z",
"your_bank_account_id": "...",
"payouts": [
{
"amount": 30000,
"description": "Payment to customer A",
"recipient_contact_id": "...",
}],
... other parameters available, see API docs
}
Payments in real-time...(Try NPP)
To make real-time payments from a Float Account enabled for NPP, simply set the value of the your_bank_account_id field in the request above to the ID of your NPP enabled Float Account. The ID of your Float Account can be found within the Zepto UI, or by calling the following end-point: https://docs.zepto.money/#Zepto-API
POST /payments
{
"description": "The SuperPackage",
"matures_at": "2016-09-13T00:00:00Z",
"your_bank_account_id": "...",
//option 1 'channels':['new_payments_platform'],
//option 2 'channels':['direct_entry'],
//option 3 'channels':['new_payments_platform','direct_entry'],
"payouts": [
{
"amount": 30000,
"description": "Payment to customer A",
"recipient_contact_id": "...",
}
],
... other parameters available, see API docs
}
You can choose between the three options while making a payment via the float account:
“channels”: [“direct_entry”]- When specified the transaction will only be processed using the DE channel. If the transaction fails via DE, the whole transaction will fail.“channels”: [“new_payments_platform”]- When specified the transaction will only be processed via the NPP channel. If the transaction fails via the NPP, the whole transaction will fail.“channels”: [“new_payments_platform”, “direct_entry”]- The transaction will first be processed using the NPP channel, if this fails, the transaction will be retried using the DE channel.
Webhooks:
You'll have the option to enable webhooks that will update your system on the status of payments in real-time as we are notified of the success of your transactions.
Developer Pro-tips: For more information on how to implement our webhooks please refer to the following article:
Feel free to reach out if you have further questions by emailing us directly at support@zepto.com.au or clicking on the green bubble icon from the corner of the screen.