📗

Learn how to use the Payment API to enable Singapore bank transfer deposits from your user.

Overview

Each connected user on your platform will be assigned a unique virtual account number for bank transfer payments. We check the sender's name against the user's name to ensure the payment is being made to the correct virtual account. This creates a secure and seamless experience for your users and makes it easy for your team to reconcile these transactions.

Learn more about virtual accounts →

Step 1 — Display bank transfer instructions

curl --location --request POST 'https://sandbox.xfers.io/api/v3/payment_methods/virtual_bank_accounts' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-XFERS-APP-API-KEY: t4wsjxpwtk6o9tz20j4baj4ifwibin100py1vrvfsqh' \
--form 'data[attributes][referenceId]="hello_world"' \
--form 'data[attributes][bankShortCode]="FAZZ"' \
--form 'data[relationships][customerProfile][data][id]="customer_profile_08d5ffe5-8a02-4dc2-aabb-9057b8ab3c65"'

curl --location --request POST 'https://www.xfers.io/api/v3/payment_methods/virtual_bank_accounts' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-XFERS-APP-API-KEY: {{APP_API_KEY}}' \
--form 'data[attributes][referenceId]="{{MERCHANT_REF}}"' \
--form 'data[attributes][bankShortCode]="FAZZ"' \
--form 'data[relationships][customerProfile][data][id]="{{CP_ID}}"'

• To provide payee details for your user, initiate a request to create a virtual bank account to display bank transfer instructions.
• This enables your user to add a payee in their bank app using the fields: bank name, recipient name and bank account number.

Step 2 — Add callback URL

On a successful completion of a deposit 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 3a — Make a mock bank transfer (Sandbox)

curl --location --request PUT 'https://sandbox.xfers.io/api/v3/sandbox/customer_profile/customer_profile_08d5ffe5-8a02-4dc2-aabb-9057b8ab3c65/bank_accounts/?verification_status=verified' \
--header 'X-XFERS-APP-API-KEY: t4wsjxpwtk6o9tz20j4baj4ifwibin100py1vrvfsqh'

• In the sandbox environment, you can initiate a mock bank transfer payment to test the creation of a bank transfer payment
• Input a name under source_bank_account_holder_name to test if the sender name is matched correctly to your user's name.

Step 3b — Make a bank transfer (Production)

👍

Bank Account Verification

Bank accounts will be verified and added to a customer profile on the first deposit when the bank name matches with the customer profile name.

To make a bank transfer payment, your users can deposit funds via their bank app.

Add payee details example

---

📘

For a full list of banks supported by StraitsX, click here.

Step 4 — Confirm deposit has been received

Securing your callback

When the payment is received, we will send a callback to the URL indicated on the StraitsX Business Dashboard. The callback can be verified using the HMAC-SHA256 algorithm.

Learn more about how to secure your callback →

amount=89.35&bank_account_no=0393123432&created_at=2022-03-09T11%3A56%3A17%2B08%3A00&end_to_end_ref=test+comment&fees=0.49&id=contract_7mowjipsez3ryhs9auko03eajihpbeop&idempotency_id=ETA2022030911561153700&merchant_ref=ref_0d1w4m0xepp40&status=completed&type=Direct+bank+transfer

👍

You may use the merchant_ref parameter to match the incoming bank transfers to verify if you have received the correct amount.

Summary

Next step — Sending a payout

Learn more about how to send a payout to your user's bank account.

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!