API Reference

Enumeration Descriptions

Review common Transfer response codes, transfer status values, and related enum dictionaries.

Status

Status Code	Description	Explanation
A	Pending Review	Transaction created, waiting for review
CA	Compliance Review	Transaction undergoing compliance review
B	Pending Check	Transaction waiting for system check
U	Review Failed	Transaction failed manual review
V	Check Failed	Transaction failed system check
R	Pending Payout	Transaction approved, waiting for payout
P	Processing Payout	Transaction being processed for payout
S	Success	Transaction completed successfully
F	Failed	Transaction processing failed

Status Code	Description	Explanation
Y	Full Amount Arrival	Beneficiary receives amount equal to target amount
N	Non-Full Amount Arrival	Beneficiary may receive less than target amount
::

Status Code	Description	Explanation
SHA	Costs shared	SWIFT fees are shared between the payer and recipient.
OUR	Costs borne by payer	The payer bears all SWIFT-related fees, and the recipient receives the full amount.
::

transactionPurpose

Code	Description	Explanation
0	Transfer to Own Account	Fund transfer to own other account
1	Personal Remittance	Fund transfer between individuals
2	Loan or Credit Repayment	Used for loan or credit bill refund
3	Technical Services	Payment for technical service fees
4	Shipping Fee	Payment for transportation-related fees
5	Professional Services/Business Services	Payment for professional or business service fees

payoutMethod

Code	Description	Explanation
SWIFT	SWIFT Submit payment	International transfer via SWIFT network
BANK_TRANSFER	Bank Submit payment	Transfer via local banking network
E_WALLET	Wallet Submit payment	Transfer to e-wallet account
CASH_PICKUP	Cash Pickup	Beneficiary can collect cash at designated location

entityType

Code	Description	Explanation
0	Company	Corporate legal entity account
1	Individual	Natural person account

currency

Code	Description	Explanation
USD	US Dollar	Legal currency of United States of America
EUR	Euro	Legal currency of European Union member countries
GBP	British Pound	Legal currency of United Kingdom
JPY	Japanese Yen	Legal currency of Japan
PHP	Philippine Peso	Legal currency of Philippines
IDR	Indonesian Rupiah	Legal currency of Indonesia
THB	Thai Baht	Legal currency of Thailand
MYR	Malaysian Ringgit	Legal currency of Malaysia

receiverInfo

Parameter	Type	Description
companyName	string(64)	Company Name
lastName	string(64)	Last Name
firstName	string(64)	First Name
areaCode	string(32)	Area Code
phone	string(16)	Mobile Number
vatNumber	string(64)	VAT Number CPF/CNPJ
birthDate	string	Date of Birth (yyyy-MM-dd)
email	string(32)	Beneficiary email, conditional field
identityType	string(32)	ID Type (e.g., SSN), conditional field

address Field Description

accountInfomation Field Description

Parameter	Type	Description
cardNumber	string(20)	Card Number/IBAN
accountType	string(64)	Account Type 0:checking, 1:saving, 2:ordinary
swiftCode	string(256)	swift code
bankName	string(250)	Bank name (optional). When provided, this field will override the default value
sortCode	string(256)	Sort Code/ABA
branchCode	string(256)	Branch Number
bankHolderName	string(32)	Bank account name
walletType	string(20)	Wallet Type
walletPhone	string(64)	Wallet Value
pickUpBankName	string(256)	Pickup Institution
pickUpBankBranchName	string(256)	Branch Institution
pickUpBankBranchId	string(256)	Branch Institution ID
pickUpBankBranchAddress	string(32)	Branch Institution Address

respCode

Code	Description	Explanation
0000	Success	Request processed successfully
1001	Parameter Error	Request parameters do not meet requirements
1002	Signature Error	Request signature verification failed
1003	Insufficient Balance	Account balance insufficient to complete transaction
1004	Limit Exceeded	Transaction limit exceeded
2001	System Error	System internal processing exception
2002	Network Timeout	Network connection timeout
3001	Account Frozen	Account frozen and cannot operate
3002	Duplicate Request	Duplicate submitted request

Notes

All enum values are case-sensitive
Currency codes follow ISO 4217 standard
Response codes only list common statuses, refer to error code documentation for detailed error codes

Parameter	Type	Description
payoutId	integer	ID
paymentMethod	string	Payment Method
payoutType	string	Payout Type
settleCurrency	string	Settlement Currency
settleSumAmount	number	Settlement Summary Amount
serviceFee	number	Service Fee
otherFee	number	Other Fees
frozenAmount	number	Risk Control Frozen Amount
settleAmount	number	Actual Settlement Amount
payoutCurrency	string	Payout Currency
payoutAmount	number	Payout Amount
convRate	number	Conversion FX Rate
merchantNo	integer	Merchant Number
beneficiaryId	integer	beneficiary ID
beneficiaryName	string	Name of Beneficiary
beneficiaryBankName	string	Beneficiary Bank name
beneficiaryBankAddress	string	Beneficiary Bank Address
beneficiaryAccount	string	Beneficiary Account
beneficiaryAccountCountry	string	Beneficiary Account Country
beneficiaryAccountName	string	Beneficiary Account Name
beneficiaryAccountSwiftCode	string	Beneficiary Account SWIFT CODE
beneficiaryAccountLocalCode	string	Beneficiary Account LOCAL CODE
beneficiaryCountry	string	Beneficiary Country
beneficiaryAddress	string	Beneficiary Address
mobileNumber	string	Mobile Number
payoutStatus	string	Payout Status
payoutTips	string	Customer Tips
payoutRemark	string	Exception Tips
payoutTime	string	Payout Time
distributeStatus	string	Distribution Status
distributePs	string	Payment Reference
transactionPurpose	string	Transaction Purpose
remark	string	Remark
createTime	string	Creation time
updateTime	string	Update Time
payoutMethod	string	Payment Method payoutMethod enum value
firstName	string	Beneficiary - First Name
lastName	string	Beneficiary - Last Name
companyName	string	Company Name

Transfer Callback

Receive asynchronous callbacks when the transfer status changes and update your business order accordingly.