Overview

We have updated our API documentation to introduce new functionality and improve clarity for existing integration flows:

1. New Enhancement: Added custom payment description support to improve processing flow with recipient banks.
2. Documentation Improvements: Updated FAQs, callback event references, and API specifications to reflect the latest system behaviors.

Part 1: New Enhancement

We’ve added support for the paymentReason field in both the Customer Profile Bank Account and Payout Recipient APIs.

📘

Payment reason is a field used to pass clear, specific instructions to the receiving bank. It is sent as the payment description to the bank and will override the Remittance Information (MT103 Field 70 / pacs.008 Remittance Information) in the payment message.

Endpoints:

• POST /v1/customer_profile/{customer_profile_id}/payout-recipients
• PATCH /v1/customer_profile/{customer_profile_id}/payout-recipients/{recipient_id}
• GET /v1/customer_profile/{customer_profile_id}/payout-recipients/{recipient_id}
• GET /v1/customer_profile/{customer_profile}/payout-recipients
• POST /v1/payout-recipients
• PATCH /v1/payout-recipients/{recipient_id}
• GET /v1/payout-recipients/{recipient_id}
• GET /v1/payout-recipients

Endpoints:

• POST /v1/customer_profile/{customer_profile_id}/bank_accounts
• PUT /v1/customer_profile/{customer_profile_id}/bank_accounts/{bank_account_id}
• GET /v1/customer_profile/{customer_profile_id}/bank_accounts

Part 2: Documentation Improvements

1. Guides > FAQs

• Bank Account FAQs: Updated Question 2 to include the new callback event cpbaVerificationStatusUpdated.
• Swap FAQs: Updated Question 1 to include XSGDUSDT swap pair.

2. Guides > Resources > Webhook / Callbacks > Callback Samples

• Deposit/Payment Callbacks: Added description on the payment transactions payload structure.
• Blockchain Deposit and Withdrawal Status Update Callbacks: Added callback sample for the Blockchain Deposit Status Update.
• Added new callback samples for Customer Profile Bank Account Callbacks.

3. API Reference

• Get Account Statement API: Updated the query parameter filter[currency] to allow sgd and usd currency filtering options.
• Webhook APIs: Updated the Get webhooks and Update webhooks API to include below events.
  • cpbaVerificationStatusUpdated
  • cpbaCreated
  • ubaCreated
  • ubaVerificationStatusUpdated
• Update Transaction Limit API: Updated the response schema to include customerProfileId attribute.
• Get Supported Swap Pairs API: Updated the response sample data to include XSGDUSDT swap pair.
• Create a First Party Bank Transfer Payout API: Updated the request schema attribute purpose_code description to include applicability for payments to UAE (in addition to SGD FAST payouts), and added validation for alphanumeric values up to 6 characters.