Create a Contact
Create a Contact
Make a Payment to a Contact
Direct Debit a Contact
Refund a Direct Debit
Create a Receivable Contact
Receive a Payment
01
Create a Contact
Create a Contact
A Contact represents an entity and their related bank account. You can pay a Contact or pair it with an Agreement to collect funds from the Contact.
Zepto | POST /contacts
{
"name": "Hunter S. Thompson",
"email": "[email protected]",
"branch_code": "123456",
"account_number": "13048322"
}Zepto | Response (Status code - 201 created)
{
"name": "Hunter S. Thompson",
"email": "[email protected]",
"branch_code": "123456",
"account_number": "13048322"
}02
Make a Payment to a Contact
Make a Payment to a Contact
Pay the Contact via your choice of real time or slower traditional channels.
Zepto | POST /payments
{
"description": "The SuperPackage",
"matures_at": "2021-06-13T00:00:00Z",
"channels": [
"new_payments_platform"
],
"payouts": [
{
"amount": 30000,
"description": "A tandem skydive jump SB23094",
"recipient_contact_id": "48b89364-1577-4c81-ba02-96705895d457"
}
]
}Zepto | Response (Status code - 201 created)
{
"description": "The SuperPackage",
"matures_at": "2021-06-13T00:00:00Z",
"channels": [
"new_payments_platform"
],
"payouts": [
{
"amount": 30000,
"description": "A tandem skydive jump SB23094",
"recipient_contact_id": "48b89364-1577-4c81-ba02-96705895d457"
}
]
}03
Direct Debit a Contact
Direct Debit a Contact
Initiate a Payment Request to collect funds via Direct Debit from a Contact where an Agreement exists and is active.
Zepto | POST /payment_requests
{
"description": "Visible to both initiator and authoriser",
"matures_at": "2016-12-19T02:10:56.000Z",
"amount": 99000,
"authoriser_contact_id": "de86472c-c027-4735-a6a7-234366a27fc7"
}Zepto | Response (Status code - 200 okay)
{
"description": "Visible to both initiator and authoriser",
"matures_at": "2016-12-19T02:10:56.000Z",
"amount": 99000,
"authoriser_contact_id": "de86472c-c027-4735-a6a7-234366a27fc7"
}04
Refund a Direct Debit
Refund a Direct Debit
Refund a successful Payment Request to return collected funds. Full or multiple partials, no problem.
Zepto | POST /credits/{credit_ref}/refunds
{
"amount": 500,
"channels": [
"direct_entry"
],
"reason": "Because reason"
}Zepto | Response (Status code - 200 okay)
{
"amount": 500,
"channels": [
"direct_entry"
],
"reason": "Because reason"
}05
Create a Receivable Contact
Create a Receivable Contact
Use a Receivable Contact to create a float account representing your customer. The float account provides you with a unique BSB, account number and PayID.
Zepto | POST /contacts/receivable
{
"name": "Hunter S. Thompson",
"email": "[email protected]",
"payid_email": "[email protected]",
"metadata": {
"custom_key": "Custom string",
"another_custom_key": "Maybe a URL"
}
}Zepto | Response (Status code - 201 created)
{
"name": "Hunter S. Thompson",
"email": "[email protected]",
"payid_email": "[email protected]",
"metadata": {
"custom_key": "Custom string",
"another_custom_key": "Maybe a URL"
}
}06
Receive a Payment
Receive a Payment
Share the Receivable Contact account details with your customer and start receiving automatically reconciled funds, in real time.
Zepto | Webhook Delivery
{
"data": [
{
"your_bank_account_id": "1d0eac6b-a81d-4bad-ab9e-8006b16aa185",
"payout": {
"amount": 2500,
"matures_at": "2020-11-26T13:00:00Z",
"description": "1"
},
"matures_at": "2020-11-26T13:00:00Z",
"created_at": "2020-11-26T22:23:09Z",
"initiator_id": "1d0eac6b-a81d-4bad-ab9e-8006b16aa185",
"schedule_ref": null,
"credit_ref": "C.3dv9",
"metadata": {
"npp_payment_reference": "Test Payment",
"npp_debtor_name": "Hunter S. Thompson",
"npp_payment_transaction_id": "ESFHAU21XXXN20210608DA0000013537000",
"npp_debtor_legal_name": "Hiunter S. Thompson",
"npp_alias_value": "[email protected]",
"npp_payment_description": "Test Payment",
"npp_debtor_branch_code": "014209",
"npp_debtor_account_number": "12345678",
"npp_alias_type": "/EMAL"
},
"status_reason": null,
"status": "approved",
"ref": "PR.pnb",
"authoriser_contact_id": "a7565a92-a570-4ad1-b5c9-e6763e8af42e",
"authoriser_id": "c0dd0b3b-555e-41ec-983e-14f7b6e7dc59",
"responded_at": "2020-11-26T22:23:09Z"
}
],
"event": {
"at": "2020-11-26T22:23:09Z",
"who": {
"account_id": "ba5c54ce-de1e-4355-9864-fdd7b90fbae0",
"account_type": "AnyoneAccount",
"bank_account_id": "c0dd0b3b-555e-41ec-983e-14f7b6e7dc59",
"bank_account_type": "BankAccount"
},
"type": "payment_request.approved"
}
}API Docs
Tap the power of Zepto by using our sophisticated yet simple-to-use API. Built as a RESTful API using JSON as its data-interchange format, it’s designed to feel homely but behave performant and modular-in-style. Go on, give our API documentation a read. We’ve even got a Postman collection in there for you to play with, no code required!
Dive In
Sandbox Environment
The best way to familiarise yourself with Zepto’s API is by interacting with it. Try our sandbox environment today and look for the support launcher to talk with our integration team.
- Isolated testing
- Production behaviour
- Reliable integration testing
- Always free
Help Centre
Zepto’s Help Centre contains useful articles, cheat sheets and deeper insights to help with your integration. This is constantly updated with release notes and articles.
- Getting started
- Custom payment forms
- Import/export data
"The speed of Superhero's integration with Zepto far surpassed any expectation. The team at Zepto work efficiently but to the highest standard, and we were able to achieve a seamless integration and launch quickly to deliver for our customers."John Winters Co-Founder & CEO, Superhero
"The speed of Superhero's integration with Zepto far surpassed any expectation. The team at Zepto work efficiently but to the highest standard, and we were able to achieve a seamless integration and launch quickly to deliver for our customers."John Winters Co-Founder & CEO, Superhero
Receive mission updates...
Subscribe to our newsletter to stay in-the-know with the latest payment news, expert insights and all things Zepto.