1. Welcome |
2. High-Level PayTo Flow |
Integration Guide Overview
Before we get into the details, let's set the scene and see what's possible with PayTo.
NOTE: A PayTo Agreement is completely separate from a traditional DDR Agreement used for Direct Debit on existing account to account infrastructure (BECS). Even though both concepts enable a layer of consent allowing funds to be pulled from a bank account - both follow very different integration flows and connect to separate underlying account-to-account payment rails (NPP vs BECS).
PayTo Agreements
Before funds can be collected from a customer, an authorised PayTo Agreement must be established. This is the consent model that sits between you and your end customer, allowing your business to collect funds from their nominated bank account (as long as the payment complies with the terms of the PayTo Agreement).
When a PayTo Agreement is created for your customer, they will receive a notification from their financial institution informing them of the pending Agreement awaiting their authorisation. Depending on the financial institution, and the banking channel used by the customer, that notification may be delivered via a number of channels including native app notification, email, text message - notification methods are entirely up to the receiving Financial Institution.
Once notified, the customer has 5 days to Authorise the Agreement (Accept or Decline). If they have not responded within this timeframe, the Agreement will automatically expire.
Once Accepted, the Agreement will become Active and can then be used for all subsequent PayTo activities.
PayTo Agreement Flow Diagram
The steps below outline the creation and management flow for Agreements.
Step 1 - Create an Agreement
Create an Agreement for the goods & services payment arrangement being set up between you and your customer.
Step 2 - Pre-authorised Agreement Actions
Wait for your customer to action the PayTo Agreement from within their banking portal:
Customer Actions | Result |
Authorise | If they choose to Accept the Agreement, the state of the Agreement will move from:
Created > Active |
Decline | If they choose to Decline the Agreement, the state of the Agreement will move from:
Created > Declined |
Nothing | If the customer does nothing, then after 5 days the Agreement will become Expired and the state will move from:
Created > Expired |
At any point in time, you may initiate a Cancellation:
Merchant Action | Description |
Pre-authorisation Cancel | In a scenario where a PayTo Agreement has been incorrectly issued and the customer has not yet actioned it, a Cancellation can be used to recall it.
This will allow you to create a new Agreement with the correct information.
Created > Cancelled |
Post-authorisation Cancel | In the scenario where the Agreement has reached end-of-life, Cancellations should be used to ensure that a proliferation of active unused/unusable Agreements are not held Active within the NPP.
Created > Cancelled |
NOTE: A PayTo Agreement can not be used to collect funds until it has been Accepted. It must be in an Active state in order to initiate Payments against it.
Step 3 - Post-authorised Agreement Actions
Once a PayTo Agreement has been Authorised by your customer, it will move into the Active state at which point the following actions are supported:
Action | Description |
Suspended/Reactivated | This action can be performed by:
A Reactivation may only be performed by the party that originally Suspended the Agreement.
A Suspended Agreement can not be used to collect funds. |
Cancelled | This action can be performed by:
A Cancelled Agreement is a Final state, and can never be resurrected.
A Cancelled Agreement can not be used to collect funds. |
Amended | This action can be performed by:
Each party can amend specific fields, but not all of them. For more details please see the API Docs. |
PayTo Payment
Once an Active PayTo Agreement is in place between you and your customer you can start collecting funds as long as the collection request falls within the agreed terms of the Authorised Agreement.
Zepto will validate all PayTo Payments against the PayTo Agreement supplied and will reject any Payments that fall outside of the agreed terms.
NOTE: Once a PayTo Payment has been validated and submitted onto the NPP, it is irrevocable and cannot be cancelled.
PayTo Payment Flow
