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


Parameter

Data Type/ Length

Mandatory

Description

version

C 15

M

API Version

Current version is 1.0

merchantID

C 15

M

Merchant ID Provided by 2C2P
to merchant.

 

Withdraw Options Response Parameters


Parameter

Data Type / Length

Mandatory

Description

version

C 5

M

API Version

Current version is 1.0

respCode

C 2

M

Response Code

Refer to response code list.

respDesc

C 100

M

Response description

withdrawOption

Array

M

Array of withdrawal options

withdrawOption - merchantID

C 15

M

Payment request merchant ID.
Provided by 2C2P
to merchant.

withdrawOption - withdrawOptionID

N 5

M

Withdraw Option ID to be used when requesting for
withdrawal.

withdrawOption - name

C 100

M

Name to describe the withdrawal option.

withdrawOption - processingTime

C 100

M

Withdraw option processing time.

withdrawOption - feeMargin

D 10,2

M

Threshold amount. If withdraw amount less than margin, feeLower applies. Otherwise feeUpper applies.

withdrawOption - feeLower

D 10,2

M

Fee of withdraw amount less than FeeMargin or when feeMargin is 0.

withdrawOption - feeLowerIsPercentage

B

M

Fee is percentage indicator.

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

withdrawOption - feeUpper

D 10,2

O

Fee of withdraw amount more or equal to FeeMargin.

Only used when feeMargin is more than 0.

withdrawOption - feeUpperIsPercentage

B

O

Fee is percentage indicator.

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

 

Withdraw Request Parameters


Parameter

Data Type / Length

Mandatory

Description

version

C 5

M

API Version

Current version is 1.0

merchantID

C 15

M

Merchant ID Provided by 2C2P
to merchant.

withdrawOptionID

N 5

M

Withdraw Option ID

amount

D 10,2

M

Withdraw amount

 

Withdraw Response Parameters


Parameter

Data Type / Length

Mandatory

Description

version

C 5

M

API Version

Current version is 1.0

respCode

C 2

M

Response Code

Refer to response code list.

respDesc

C 100

M

Response code description.

withdrawRefNo

N 20

M

Withdrawal reference number.

It is used for tracing. appears on transaction history description.

withdrawOptionID

N 5

M

Withdraw option ID.

amount

D 10,2

M

Withdraw amount

currency

C 3

M

Currency Code.

Refer List of currency code (A3).

fee

D 10,2

M

Processing fee.

netAmount

D 10,2

M

Net withdrawal amount.

 

Balance Inquiry Request Parameters


Parameter

Data Type / Length

Mandatory

Description

version

C 5

M

API Version

Current version is 1.0

merchantID

C 15

M

Merchant ID Provided by 2C2P
to merchant.

 

Balance Inquiry Response Parameters


Parameter

Data Type / Length

Mandatory

Description

version

C 5

M

API Version

Current version is 1.0

respCode

C 2

M

Response Code

Refer to response code list.

respDesc

C 100

M

Response code description.

availableBalance

D 10,2

M

Merchant account’s available balance.

currency

C 3

M

Currency code.

Refer List of currency code (A3).