Skip to content

Enumeration Descriptions ​

Status ​

Status

Status CodeDescriptionExplanation
APending ReviewTransaction created, waiting for review
CACompliance ReviewTransaction undergoing compliance review
BPending CheckTransaction waiting for system check
UReview FailedTransaction failed manual review
VCheck FailedTransaction failed system check
RPending PayoutTransaction approved, waiting for payout
PProcessing PayoutTransaction being processed for payout
SSuccessTransaction completed successfully
FFailedTransaction processing failed

Full Amount Arrival Flag ​

chargeFlag

Status CodeDescriptionExplanation
YFull Amount ArrivalPayee receives amount equal to target amount
NNon-Full Amount ArrivalPayee may receive less than target amount

Swift Fee Bearing Method ​

feeBearing

Status CodeDescriptionExplanation
SHACosts sharedSWIFT fees are shared between the sender and recipient.
OURCosts borne by payerThe sender bears all SWIFT-related fees, and the recipient receives the full amount.

Transaction Purpose ​

transactionPurpose

CodeDescriptionExplanation
0Transfer to Own AccountFund transfer to own other account
2Loan or Credit RepaymentUsed for loan or credit bill repayment
4Shipping FeePayment for transportation-related fees
5Professional Services/Business ServicesPayment for professional or business service fees

Payment Method ​

payoutMethod

CodeDescriptionExplanation
SWIFTSWIFT Submit paymentInternational transfer via SWIFT network
BANK_TRANSFERBank Submit paymentTransfer via local banking network
E_WALLETWallet Submit paymentTransfer to e-wallet account
CASH_PICKUPCash PickupPayee can collect cash at designated location

Wallet Type ​

For e-wallet payouts, select walletType according to the recipient's wallet and account type, and put the wallet account identifier in walletPhone. If a wallet has multiple account types, choose the enum value that matches the supplied account.

  • Use the camelCase request field name walletType.
  • For payee creation/update and payments with payee details, include wallet information in the accountInfomation JSON string. For the payee required fields query, walletType is a request body parameter.
  • walletPhone may contain a mobile number, email address, ID number or wallet account identifier, according to the table. walletFormat describes the format; it is not an additional request field.

walletType

E-WalletwalletType enum valuewallet format
DANADANAMOBILE
GOPAYGOPAYMOBILE
GRABPAYGRABPAYMOBILE
LINKAJALINKAJAMOBILE
OVOOVOMOBILE
PAYTRENPAYTRENWALLET ID
COINSCOINSMOBILE
GCASHGCASHMOBILE
PAYMAYAPAYMAYAMOBILE
ALIPAYALIPAYMOBILE
WECHAT PAYWECHAT PAYMOBILE
DCPAYDCPAYMOBILE
UPIVPAVPA
PayNowMOBILEMOBILE
PayNowUENUEN
PayNowNRICNRIC
PayNowVPAVPA
DuitNowNRICNRIC
DuitNowPASSPORTPASSPORT
DuitNowCORPORATE_REGISTRATION_NUMBERCORPORATE_REGISTRATION_NUMBER
DuitNowMOBILEMOBILE
DuitNowARMY_IDARMY_ID
PIXMOBILEMOBILE
PIXEMAILEMAIL
PIXIDWALLET ID
PIXRANDOM_KEYRANDOM_KEY
VENMOVENMOMOBILE
PAYPALPAYPALEMAIL
PayIDABNABN
PayIDEMAILEMAIL
PayIDPHONE NUMBERMOBILE
PayIDCORPORATE IDCORPORATE ID
FPSMOBILEMOBILE
FPSEMAILEMAIL
FPSFPS IDWALLET ID
KEAirtelAirtel
KEEquitelEquitel
KEMpesaMpesa
ShopeePayShopeePayMOBILE
MomoMomoMOBILE
VNPTVNPTMOBILE
ZaloPayZaloPayMOBILE
VNPayVNPayMOBILE
TnGTnGDuitnow ID
BKASHBKASHMOBILE
ROCKEYROCKEYWALLET ID
NAGADNAGADMOBILE
PAPARAPAPARA_NUMBERNUMBER
PAPARAPAPARA_EMAILEMAIL
PAPARAPAPARA_PHONEMOBILE
PAPARAPAPARA_TURKISHTURKISH
ALFAALFAWALLET ID
KONNECTKONNECTWALLET ID
EASYPAISAEASYPAISAWALLET ID
FINCAFINCAWALLET ID
APNAAPNAWALLET ID
UBANKUBANKWALLET ID
JAZZCASHJAZZCASHWALLET ID
ADVANSADVANSWALLET ID
KHUSHALIKHUSHALIWALLET ID
NAYAPAYNAYAPAYWALLET ID
PAYMAXPAYMAXWALLET ID
SADAPAYSADAPAYWALLET ID
BYKEABYKEAWALLET ID
FINJAFINJAWALLET ID
TMFBTMFBWALLET ID
BANKALFABANKALFAMOBILE
UPAISAUPAISAMOBILE
BigPayBigPayDuitnow ID
Wallet account example

This is an account information fragment. Supply all other required fields as specified by the relevant endpoint.

json
{
  "paymentMethod": "E_WALLET",
  "accountInfomation": "{\"walletType\":\"PAYPAL\",\"walletPhone\":\"payee@example.com\"}"
}

Entity Type ​

entityType

CodeDescriptionExplanation
0CompanyCorporate legal entity account
1IndividualNatural person account

Currency ​

currency

CodeDescriptionExplanation
USDUS DollarLegal currency of United States of America
EUREuroLegal currency of European Union member countries
GBPBritish PoundLegal currency of United Kingdom
JPYJapanese YenLegal currency of Japan
PHPPhilippine PesoLegal currency of Philippines
IDRIndonesian RupiahLegal currency of Indonesia
THBThai BahtLegal currency of Thailand
MYRMalaysian RinggitLegal currency of Malaysia

Payee Information ​

receiverInfo

ParameterTypeDescription
companyNamestring(64)Company Name
lastNamestring(64)Last Name
firstNamestring(64)First Name
areaCodestring(32)Area Code
phonestring(16)Mobile Number
vatNumberstring(64)VAT Number CPF/CNPJ
birthDatestringDate of Birth (yyyy-MM-dd)
emailstring(32)Payee email, conditional field
identityTypestring(32)ID Type (e.g., SSN), conditional field

Address ​

address Field Description

ParameterTypeDescription
statestring(20)State/Province
citystring(64)City
addressLine1string(256)Address Line 1
addressLine2string(256)Address Line 2
addressLine3string(256)Address Line 3
postalCodestring(32)Postal Code

Account information ​

accountInfomation Field Description

ParameterTypeDescription
cardNumberstring(20)Card Number/IBAN
accountTypestring(64)Account Type [0:checking, 1:saving, 2:ordinary]
swiftCodestring(256)swift code
bankNamestring(250)Bank name (optional). When provided, this field will override the default value
sortCodestring(256)Sort Code/ABA
branchCodestring(256)Branch Number
bankHolderNamestring(32)Bank account name
walletTypestringWallet type enum; supply for e-wallet payouts
walletPhonestring(64)Wallet account identifier: mobile number, email, ID number or wallet platform account, according to the account format
pickUpBankNamestring(256)Pickup Institution
pickUpBankBranchNamestring(256)Branch Institution
pickUpBankBranchIdstring(256)Branch Institution ID
pickUpBankBranchAddressstring(32)Branch Institution Address

Response Code ​

respCode

CodeDescriptionExplanation
0000SuccessRequest processed successfully
1001Parameter ErrorRequest parameters do not meet requirements
1002Signature ErrorRequest signature verification failed
1003Insufficient BalanceAccount balance insufficient to complete transaction
1004Limit ExceededTransaction limit exceeded
2001System ErrorSystem internal processing exception
2002Network TimeoutNetwork connection timeout
3001Account FrozenAccount frozen and cannot operate
3002Duplicate RequestDuplicate 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

Field Description ​

ParameterTypeDescription
payoutIdintegerID
paymentMethodstringPayment Method
payoutTypestringPayout Type
settleCurrencystringSettlement Currency
settleSumAmountnumberSettlement Summary Amount
serviceFeenumberService Fee
otherFeenumberOther Fees
frozenAmountnumberRisk Control Frozen Amount
settleAmountnumberActual Settlement Amount
payoutCurrencystringPayout Currency
payoutAmountnumberPayout Amount
convRatenumberConversion FX Rate
merchantNointegerMerchant Number
payeeIdintegerPayee ID
payeeNamestringName of Payee
payeeBankNamestringPayee Bank name
payeeBankAddressstringPayee Bank Address
payeeAccountstringPayee Account
payeeAccountCountrystringPayee Account Country
payeeAccountNamestringPayee Account Name
payeeAccountSwiftCodestringPayee Account SWIFT CODE
payeeAccountLocalCodestringPayee Account LOCAL CODE
payeeCountrystringPayee Country
payeeAddressstringPayee Address
mobileNumberstringMobile Number
payoutStatusstringPayout Status
payoutTipsstringCustomer Tips
payoutRemarkstringException Tips
payoutTimestringPayout Time
distributeStatusstringDistribution Status
distributePsstringPayment Reference
transactionPurposestringTransaction Purpose
remarkstringRemark
createTimestringCreation time
updateTimestringUpdate Time
payoutMethodstringPayment Method payoutMethod enum value
firstNamestringPayee - First Name
lastNamestringPayee - Last Name
companyNamestringCompany Name

Status Description ​

ParameterTypeDescription
WAITINGStringWaiting
PROCESSStringProcessing
REJECTStringRejected
PASSStringPassed
FAILStringFailed
UNNECESSARYStringNot Required
PENDING_UPDATEStringPending Update