These docs are for v4.0.2. Click to read the latest docs for v4.3.0.

Withdrawal API

📘

Data Attribute Reference

Data Type

  • A: Alphabet
  • AN: Alphanumeric
  • C: Characters
  • B: Boolean
  • D: Decimal
  • N: Numeric

Mandatory attributes

  • M: Mandatory
  • C: Conditional
  • O: Optional

 

Withdraw Options Request Parameters


ParameterData Type/ LengthMandatoryDescription
versionC 15MAPI Version

Current version is 1.0
merchantIDC 15MMerchant ID Provided by 2C2P
to merchant.

 

Withdraw Options Response Parameters


ParameterData Type / LengthMandatoryDescription
versionC 5MAPI Version

Current version is 1.0
respCodeC 2MResponse Code

Refer to response code list.
respDescC 100MResponse description
withdrawOptionArrayMArray of withdrawal options
withdrawOption - merchantIDC 15MPayment request merchant ID.
Provided by 2C2P
to merchant.
withdrawOption - withdrawOptionIDN 5MWithdraw Option ID to be used when requesting for
withdrawal.
withdrawOption - nameC 100MName to describe the withdrawal option.
withdrawOption - processingTimeC 100MWithdraw option processing time.
withdrawOption - feeMarginD 10,2MThreshold amount. If withdraw amount less than margin, feeLower applies. Otherwise feeUpper applies.
withdrawOption - feeLowerD 10,2MFee of withdraw amount less than FeeMargin or when feeMargin is 0.
withdrawOption - feeLowerIsPercentageBMFee is percentage indicator.

False, feeLower is in amount value.
True, feeLower is in percentage rate.
withdrawOption - feeUpperD 10,2OFee of withdraw amount more or equal to FeeMargin.

Only used when feeMargin is more than 0.
withdrawOption - feeUpperIsPercentageBOFee is percentage indicator.

False, feeUpper is in amount value.
True, feeUpper is in
percentage rate.

 

Withdraw Request Parameters


ParameterData Type / LengthMandatoryDescription
versionC 5MAPI Version

Current version is 1.0
merchantIDC 15MMerchant ID Provided by 2C2P
to merchant.
withdrawOptionIDN 5MWithdraw Option ID
amountD 10,2MWithdraw amount

 

Withdraw Response Parameters


ParameterData Type / LengthMandatoryDescription
versionC 5MAPI Version

Current version is 1.0
respCodeC 2MResponse Code

Refer to response code list.
respDescC 100MResponse code description.
withdrawRefNoN 20MWithdrawal reference number.

It is used for tracing. appears on transaction history description.
withdrawOptionIDN 5MWithdraw option ID.
amountD 10,2MWithdraw amount
currencyC 3MCurrency Code.

Refer List of currency code (A3).
feeD 10,2MProcessing fee.
netAmountD 10,2MNet withdrawal amount.

 

Balance Inquiry Request Parameters


ParameterData Type / LengthMandatoryDescription
versionC 5MAPI Version

Current version is 1.0
merchantIDC 15MMerchant ID Provided by 2C2P
to merchant.

 

Balance Inquiry Response Parameters


ParameterData Type / LengthMandatoryDescription
versionC 5MAPI Version

Current version is 1.0
respCodeC 2MResponse Code

Refer to response code list.
respDescC 100MResponse code description.
availableBalanceD 10,2MMerchant account’s available balance.
currencyC 3MCurrency code.

Refer List of currency code (A3).