Dates and times
All representations of dates are strings in ISO 8601 format.
By default, the date and time field will be displayed in UTC (e.g. 2022-01-01T13:25:00Z
) time zone, if specified or configured, it can be displayed as an offset from UTC to indicate a specific time zone (e.g. 2022-01-01T23:25:00+10:00
).
Country
The country codes in PiedPay's request and response parameters use the ISO 3166 alpha-2 specification, which uses two-letter(uppercase) to stand for a country. e.g. US
Currency
The currency codes in PiedPay's request and response parameters use the ISO 4217 specification, which uses three-letter(uppercase) to stand for a currency. e.g. USD
currency or currency_local
Some API support currency
and currency_local
, in such case, only one of them should be able to be as a parameter.
currency
refers to the request currency, usually the pricing currency of your product, and the fulfilment currency that PiedPay uses as a reference for settlement calculation. Please note that the actual amount for the end-consumer/benificiary may not match this currency. If currency value equals to a payment method supported currency_local value, the effect will be same as pass currency_local.
currency_local
(legacy, may be deprecated in the future) refers to the currency supported by the payment method itself, i.e. the currency of the actual amount paid/received by the end consumer/receiver. This parameter allows you to explicitly specify the amount of money to be received/paid. If you pass this parameter as the currency you will not incur a currency conversion fee during the initiation phase.
Phone
The phone numbers in PiedPay's request and response parameters use the E.164 specification, e.g. +8613000000000
.
MCC (Merchant Category Codes)
PiedPay follows ISO 18245 to store the Merchant Category Codes (MCC), which is useful in the KYC procedure for the application of payment methods.