Banking

2025-06-26

Added Optional documentation Field to Payout API

Affected Endpoint:

• POST /api/v1/payouts, request only

Changes:

• Added an optional documentation field to the payout creation request. This field allows uploading supporting documents along with the payout request.

2025-06-12

Added support for POA file when creating account

Affected endpoints:

• POST /api/v1/accounts, request only

Changes:

• Added optional field other_documentation under the representatives array in request payload.
  • This field can be used to provide proof of address (PROOF_OF_ADDRESS) or other supporting documents during account creation.

2025-06-05

Beneficiary Schema Expansion

Affected endpoints:

• POST /api/v1/beneficiaries, request only
• GET /api/v1/beneficiaries/{id}, response only
• GET /api/v1/beneficiaries, response only
• POST /api/v1/beneficiaries/{id}, request only
• POST /api/v1/beneficiaries/check, not request, response only

Changes:

• Added additional_info.organization_code to beneficiary object (for company-type only)
  • Description: The Unified Social Credit Identifier assigned to the organization.
• This is a optional field
  

Payout Failure Reason Reporting

Affected endpoints:

• GET /api/v1/payouts/{id}, response only
• GET /api/v1/payouts, response only

Changes:

• Added failure_reason to payout response object.

2025-05-29

Removed SUBMISSION_FAILED from Payout Status Values

Affected Endpoints:

• POST /api/v1/payouts, response only
• GET /api/v1/payouts, request and response
• GET /api/v1/payouts/{id}, response only

Changes:

• Removed the SUBMISSION_FAILED status from the payout_status field.

Note:
This is a non-backward-compatible change.

2025-05-16

Added nationality and id_number Fields to Beneficiary

Affected Endpoints:

• POST /api/v1/beneficiaries (Create Beneficiary)
• POST /api/v1/beneficiaries/{id} (Update Beneficiary)
• GET /api/v1/beneficiaries/{id} (Retrieve Beneficiary)
• GET /api/v1/beneficiaries (List Beneficiaries)

Changes:

• Added a new required field: nationality
  • Two-letter country code representing the beneficiary’s nationality.
  • Note: This field is currently optional but will become mandatory after mid-June. Please ensure your integration includes this field to avoid future disruptions.
• Added a new conditional field for INDIVIDUAL type beneficiaries: id_number. Required only when all the following conditions are met:
  • The beneficiary is a Mainland China resident
  • bank_details.account_currency_code is CNH
  • payment_method is LOCAL

2025-04-17

Added Support for Retrieving Current Exchange Rates

New Endpoint:

• GET /api/v1/exchange/rates(Current Exchange Rates)

Note:

This is a reference-only endpoint. For rate-locking or quote-generation, use the Create Quote API instead.

2025-04-15

Added Support for Transaction-Type RFIs

Affected Webhook:

• Added new event type: rfi.transaction.action_required
  Enables RFI handling for deposit and payout scenarios. See Payout / Deposit RFI for more details.

Affected Endpoints:

• GET /api/v1/rfis/{id} (Retrieve RFI)
• POST /api/v1/rfis/answer (Answer RFI)
  → Added fields such as rfi_type, transaction_type, etc., to support transaction-related RFIs.

Note:
The original onboarding RFI flow (event_type = rfi.action_required) remains unchanged and fully backward-compatible.

2024-07-20

Features

• Added changelog.
• New deposit webhooks:
  • deposit.pending
  • deposit.compliance.rejected
  • deposit.completed
• New endpoints for deposit management:
  • GET /api/v1/deposit, get list of deposits.
  • GET /api/v1/deposit/{id}, retrieve a deposit by id.
  • POST /api/v1/simulation/desposit, simulate deposits into global account (sandbox environment).

Docs

• Corrected some descriptions and parameter restrictions.