📗

Learn how to use the Payout API to enable bank transfer withdrawals to your user's bank account.

Overview

You can send bank transfer payouts to users that have a verified bank account. In our system, your funds are paid out from your StraitsX Business Account to your user's bank account.

Before you begin

Ensure that you have the following prerequisites:

1. You have added your user's bank account via the Create a customer profile bank account API.
2. Your user's bank account has been verified via either of the below methods:

Step 1 — Add callback URL

On a successful completion of a withdrawal transaction, StraitsX will send a callback notification to you via a callback URL indicated on the StraitsX Business Dashboard.

📘

Add the callback URL on the dashboard to receive a callback when the transaction has been completed.

Step 2 — Making a bank transfer payout

• Make a bank transfer payout to a user's verified bank account

Step 3 — Complete the mock bank transfer payout (Sandbox Only)

• Complete a bank transfer payout in sandbox environment
• This step can be skipped in production mode

Step 4 — Confirm withdrawal has been completed

Securing your callback

When the payout status is updated, we will send a callback to the URL indicated on the StraitsX Business Dashboard. To view samples of the callback, check out the API reference. The callback can be verified using the HMAC-SHA256 algorithm. In order to prevent repeated disbursement, you should always rely on the callback for the updated status of the submitted payout request - it is important you familiarise yourself with our guide on Transaction Safety and Idempotent Requests.

Learn more about how to secure your callback →

Try it out!

Getting started with StraitsX APIs is easy. Our business development and integration teams will be with you every step of the way. If you have any questions or would like to connect with our team, please do so via Support!