Usage rules of the Amount object
Currency-related data fields exist for both APIs and reconciliation reports. One of them is the amount object that is used by a lot of fields. The amount field has the sub-fields currency and value:
Field | Description |
currency | MANDATORY String (3) |
value | MANDATORY String (16) The amount to charge as a positive integer in the smallest currency unit. For example, $1.00 should be charged as 100 cents to charge USD 1.00, or 100 to charge JPY 100, a zero-decimal currency. |
Table 1. Sub-fields of the amount object
When using the amount object, you need to follow the usage rules to avoid problems.
Smallest unit of the currency
The actual value in the value field of the amount field is represented in the smallest unit of the currency.Antom follows the ISO 4217 standard for the definition of the smallest unit of a currency. For example:
Currency Code | Smallest Unit (Number of the Digits after Decimal) | Value in the Amount |
USD | cent (2) | 1.00 USD needs to be set as "value:100" |
PHP | cent (2) | 1.00 PHP needs to be set as "value:100" |
IDR | cent (2) | 1.00 IDR needs to be set as "value:100" |
KRW | yuan (0) | 1 KRW needs to be set as "value:1" |
THB | cent (2) | 1.00 THB needs to be set as "value: 100" |
HKD | cent (2) | 1.00 HKD needs to be set as "value: 100" |
MYR | cent (2) | 1.00 MYR needs to be set as "value: 100" |
CNY | cent (2) | 1.00 CNY needs to be set as "value: 100" |
BDT | cent (2) | 1.00 BDT needs to be set as "value: 100" |
PKR | cent (2) | 1.00 PKR needs to be set as "value: 100" |
TWD | cent (2) | 1.00 TWD needs to be set as "value: 100" |
Table 2. Currency smallest units
Minimum amount rules
For the paymentAmount or refundAmount field, the minimum amount allowed varies for each wallet. The following table shows the details about the minimum payment amount and minimum refund amount of each wallet:
Wallet | Minimum payment amount | Minimum refund amount |
TrueMoney | 1 THB | 1 THB |
AlipayHK | 0.01 HKD | 0.01 HKD |
| Touch'n Go eWallet | 0.05 MYR | 0.05 MYR |
GCash | 1 PHP | 1 PHP |
DANA | 300 IDR | 300 IDR |
| Kakao Pay | 50 KRW | 50 KRW |
JKOPay | 1 TWD | 1 TWD |