Model
Address
No. | Field | Description |
1 | region | MANDATORY String (2) The region where the address is located. The value of this parameter must be a 2-character country/region code that follows the ISO 3166 standard. |
2 | state | OPTIONAL String (8) The state, country, or province where the address is located. |
3 | city | OPTIONAL String (32) The city, district, suburb, town, or village where the address is located. |
4 | address1 | OPTIONAL String (256) The address line 1, which contains the street name, PO box, or company name. |
5 | address2 | OPTIONAL String (256) The address line 2, which contains the apartment, suite, unit, or building name. |
6 | zipCode | OPTIONAL String (32) The zip or postal code. |
Amount
No. | Field | Description |
1 | currency | MANDATORY String (3) The currency code of the amount. The value of this parameter must be an alphabetic code that follows the ISO 4217 standard, for example, "EUR" for Euros. |
2 | value | MANDATORY Integer (1 - unlimited) The value of the amount is a natural number. By default, the value of this parameter is in the smallest currency unit. For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1, set the value of this parameter to 1. Due to the currency practices in Indonesia, when the currency is IDR, round the amount with the banker's rounding and fix the last two digits of the value of this parameter as |
Env
No. | Field | Description |
1 | clientIp | OPTIONAL String (32) The IP address of the client device. |
2 | storeTerminalId | OPTIONAL String (64) The ID of the terminal device that is used in the store to process the original credit transaction. |
3 | storeTerminalRequestTime | OPTIONAL Datetime The time when the request is sent by the terminal device that is used in the store. |
Merchant
No. | Field | Description |
1 | referenceMerchantId | MANDATORY String (32) The unique ID that is assigned by the ACQP to identify a merchant. |
2 | merchantMCC | MANDATORY String (4) The merchant category code (MCC) that represents the categorization of the merchant's business type. See Alipay+ MCC Standards for details. |
3 | merchantName | MANDATORY String (256) The legal name of the merchant. |
4 | merchantAddress | MANDATORY Address In the Tax Refund scenario, specify the region where the original credit transaction occurs. |
5 | merchantDisplayName | OPTIONAL String (64) The display name of the merchant. |
PaymentMethod
No. | Field | Description |
1 | paymentMethodType | MANDATORY String (32) The type of payment method. Valid values are:
|
2 | paymentMethodId | OPTIONAL String (128) The unique ID that is assigned by Alipay+ to identify a payment method. |
Quote
No. | Field | Description |
1 | quoteId | MANDATORY String (64) The unique ID that is assigned by Alipay+ to identify an exchange rate. |
2 | quoteCurrencyPair | MANDATORY String (8) A currency pair, of which the first listed currency (also called base currency) is quoted against the second currency (also called quote currency). The value of this parameter is in the format of |
3 | quotePrice | MANDATORY Decimal (0 - unlimited) The quotation of the exchange rate between the currency pair that is specified on the quoteCurrencyPair parameter. |
Result
No. | Field | Description |
1 | resultCode | MANDATORY String (64) The result code that indicates the detailed processing result. |
2 | resultStatus | MANDATORY String The result status that indicates the processing result. Valid values are:
|
3 | resultMessage | OPTIONAL String (256) The result message that describes the result code in detail. |
User
No. | Field | Description |
1 | userId | MANDATORY String (64) The unique ID that is assigned by the MPP to identify a user. |
2 | userLoginId | OPTIONAL String (64) The ID that the user uses to log in to the MPP platform. The ID is assigned by the MPP and is desensitized. |
3 | userName | OPTIONAL UserName The user name. |
UserName
No. | Field | Description |
1 | firstName | OPTIONAL String (32) The first name of the user. |
2 | middleName | OPTIONAL String (32) The middle name of the user. |
3 | lastName | OPTIONAL String (32) The last name of the user. |
4 | fullName | MANDATORY String (128) The full name of the user. |