BPAY Payin Workflow

📘

Australia only

This guide is for platforms operating in Australia.

Overview

This integration guide will run you through how to use BPAY to directly fund a user’s digital wallet with Zai.
Provide BPAY deposit details to your customers, once they provide funds to the BPAY account, Zai will send a webhook for each customer’s wallet account receiving funds. At this point, you will implement business logic that moves these funds into their digital wallet.

Getting Started

Before you can run your BPAY workflow there are a few setup steps that need to be completed so that all of the pieces are available.

Terminology used
The following terminology is used throughout this guide:

• Platform​ refers to you as a Zai customer, or your website, application, marketplace etc.
• User​ refers to your customer who has a User record in Zai.
• Item​ is the mechanism for moving funds between users in the API.
• Payin​ is money being paid into the Zai ecosystem.
• Payout​ is money being paid out of the Zai ecosystem.

API steps

1. Check if a ​user​ already exists in Zai.
   GET /users/:id
2. Create ​user​ in Zai if it doesn’t exist in step 1.
   POST /users
3. Update ​user​ in Zai if it does exist in step 1.
   PATCH /users/:id
4. Get the ​digital wallet​ account ID for the user.
   GET /users/:id/wallet_accounts
5. Get the BPAY details for the user.
   GET /wallet_accounts/:id/bpay_details
6. (Once off) Set up ​Callback​ (webhook) on the ​transactions​ object to be notified of incoming BPAY funds.
   POST /callbacks

"object_type": "transactions",

7. (Once off) Set up ​Callback​ (webhook) on the Batch Transactions object to be notified of incoming BPAY funds.
   POST /callbacks

"object_type": "batch_transactions",

8. (Pre-live only) Fund a user’s digital wallet with BPAY.
   PATCH /testing/wallet_accounts/process_bpay

{
  "crn": "Customer reference number - reference from wallet", 
  "amount": 10000 // Amount in cents
}

Once the BPAY payin has happened you will receive the batch_transactions callback indicating that the BPAY payin is pending.

After settlement of the BPAY payin has occurred (next business day) you will receive the callbacks from step 7 and 8 on the transactions and/or batch_transactions object with a status of successful.

If you are after more information on the BPAY payin you can perform a call on batch_transactions with passing the batch_transaction id. (see below)

/batch_transactions/dabcfd50-bf5a-0138-7b40-0a58a9feac03

9. Create ​Item​ (use Type=2) to pay the payin account from the user’s account.
   POST /items
10. Fund the ​Item​ with the user’s ​digital wallet​ account.
    PATCH /items/:id/make_payment
    Funds will be automatically disbursed to your bank account.

Design considerations

When designing how this workflow will interface with your platform, we suggest storing a map of specific object IDs on your side in order to reduce the number of API calls required throughout the API workflow.

User data design

Payin data design

Once you’ve run through the API steps and implemented something like the above in your platform, the sequence of calls to run the payin workflow in production will be reduced to:

1. Create user in Zai if it doesn’t exist in step 1.
   POST /users
2. Update user in Zai if it does exist in step 1.
   PATCH /users/:id
3. Catch the callback when the user’s digital wallet is funded via BPAY.
4. Create Item to pay the payin account from the user’s account.
   POST /items
5. Fund the Item with the user’s digital wallet account.
   PATCH /items/:id/make_payment