# pay (non-NFC Payment) Alipay+ uses the **pay** API in the following three scenarios: - User-presented Mode Payment: Alipay+ sends a request to the Mobile Payment Provider (MPP) to deduct funds from the user's MPP account using the payment code. - Auto Debit: Alipay+ sends a request to the MPP to deduct funds from the user's MPP account using the authorized access token. - Auto Debit Payment Evaluation: Alipay+ sends a request to the MPP to check whether the user's MPP account has sufficient balance or is KYC compliant. In this scenario, no actual payment occurs. > **Note**: > > - Some parameters, such as _order_ and _paymentMethod_, have varying assignment requirements in different payment scenarios. Please pay attention to these differences while reviewing this API documentation. > - In the following sections, Mobile Payment Provider (MPP) is also known as Payment Service Provider (PSP). For example, the _pspId_ parameter specifies the ID that identifies an MPP. ## Structure A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see: - [Request header](api_overview#3mLq0) - [Response header](api_overview#YdmVS) > **Note**: > > 1. Set the data type of each parameter (except array) as String. This means that you must use double quotation marks (" ") to enclose the parameter value. Examples: > > - If the data type of a parameter is Integer and its value is 20, set it as "20". > - If the data type of a parameter is Boolean and its value is `true`, set it as "true". > > 2. For optional parameters that are not required in your case, you can take one of the following actions: > > - Exclude the parameters from the request body. > - Set the parameter values as `null` (without the double quotation marks). > > Do NOT leave the optional parameters empty by setting their values as `""`; otherwise, an error might occur. ## Request parameters #### acquirerId (String, REQUIRED) The unique ID that is assigned by Alipay+ to identify an ACQP. More information: - Maximum length: 64 characters #### pspId (String, REQUIRED) The unique ID that is assigned by Alipay+ to identify an MPP. More information: - Maximum length: 64 characters #### order (Order, REQUIRED) The order details that are agreed upon by the buyer and the merchant, including the information about the buyer, the merchant, the goods, the initial order amount, and so on. The order details are displayed in purchase records and used for risk and regulatory reporting. ##### referenceOrderId (String, REQUIRED) The unique ID that is assigned by the merchant to identify an order. The ID is used to display the user's purchase record and to track follow-up operations, such as customer complaints and disputes. More information: - Maximum length: 64 characters ##### orderDescription (String, REQUIRED) The description of the order. More information: - Maximum length: 256 characters ##### orderAmount (Amount, REQUIRED) The initial order amount that is used by the merchant when displaying the customer consumption records or payment result page. ###### currency (String, REQUIRED) The currency code of the amount. The value of this parameter must be an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, for example, "EUR" for Euros. More information: - Maximum length: 3 characters ###### value (Integer, REQUIRED) The value of the amount as a natural number. By default, the value of this parameter is in the smallest currency unit as listed in [the Current Currency & Funds list](https://www.currency-iso.org/en/home/tables/table-a1.html). In the list, the Minor unit column defines the number of decimals, which determines the smallest unit of a currency. For example, if the currency is USD and the amount is $1.00 (2 decimals), set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1 (0 decimal), set the value of this parameter to 1. More information: - Value range: 1 - unlimited ##### merchant (Merchant, REQUIRED) The merchant information, including the merchant ID, merchant name, merchant category code, and so on. ###### referenceMerchantId (String, REQUIRED) The unique ID that is assigned by Alipay+ to identify a merchant. More information: - Maximum length: 32 characters ###### merchantMCC (String, REQUIRED) The merchant category code (MCC) that represents the categorization of the merchant's business type. See [Alipay+ MCC Standards](https://docs.alipayplus.com/alipayplus/alipayplus/mcc-standards/overview.md) for details. More information: - Maximum length: 32 characters ###### merchantName (String, REQUIRED) The legal name of the merchant. More information: - Maximum length: 256 characters ###### merchantAddress (Address, REQUIRED) In the Auto Debit scenario, the address indicates the region where the merchant is registered. In the User-presented Mode Payment scenario, the address indicates the region where the payment transaction occurs. ###### region (String, REQUIRED) 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](https://www.iso.org/iso-3166-country-codes.html) standard. More information: - Maximum length: 2 characters ###### state (String) The state, country, or province where the address is located. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ###### city (String) The city, district, suburb, town, or village where the address is located. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ###### address1 (String) The address line 1, which contains the street name, PO box, or company name.  This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 256 characters ###### address2 (String) The address line 2, which contains the apartment, suite, unit, or building name. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 256 characters ###### zipCode (String) The zip or postal code. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 32 characters ###### merchantDisplayName (String, REQUIRED) The display name of the merchant. More information: - Maximum length: 64 characters ###### merchantRegisterDate (Datetime) The time when the merchant registered its business at the local regulatory agency. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard format. For example, "2019-11-27T12:01:01+08:00". ###### store (Store) The information about the store of the merchant. This parameter is specified by Alipay+ in the in-store payment scenario. ###### referenceStoreId (String, REQUIRED) The unique ID that is assigned by the merchant to identify a store. More information: - Maximum length: 32 characters ###### storeName (String, REQUIRED) The legal name of the store. More information: - Maximum length: 256 characters ###### storeMCC (String, REQUIRED) The merchant category code (MCC) that represents the categorization of the store's business type. See [Alipay+ MCC Standards](https://docs.alipayplus.com/alipayplus/alipayplus/mcc-standards/overview.md) for details. More information: - Maximum length: 32 characters ###### storeDisplayName (String) The display name of the store. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ###### storeTerminalId (String) The unique ID that is assigned by the merchant to identify a store terminal. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ###### storeAddress (Address) The address where the store is located. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. ###### region (String, REQUIRED) 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](https://www.iso.org/iso-3166-country-codes.html) standard. More information: - Maximum length: 2 characters ###### state (String) The state, country, or province where the address is located. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ###### city (String) The city, district, suburb, town, or village where the address is located. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ###### address1 (String) The address line 1, which contains the street name, PO box, or company name.  This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 256 characters ###### address2 (String) The address line 2, which contains the apartment, suite, unit, or building name. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 256 characters ###### zipCode (String) The zip or postal code. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 32 characters ##### goods (Array) The goods information, including the goods ID, goods name, and so on. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum size: 100 elements ###### referenceGoodsId (String, REQUIRED) The unique ID that is assigned by the merchant to identify the goods. More information: - Maximum length: 64 characters ###### goodsName (String, REQUIRED) The name of the goods. More information: - Maximum length: 256 characters ###### goodsCategory (String) The categorization of the goods. More information: - Maximum length: 256 characters ###### goodsUnitAmount (Amount) The unit price of the goods. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. ###### currency (String, REQUIRED) The currency code of the amount. The value of this parameter must be an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, for example, "EUR" for Euros. More information: - Maximum length: 3 characters ###### value (Integer, REQUIRED) The value of the amount as a natural number. By default, the value of this parameter is in the smallest currency unit as listed in [the Current Currency & Funds list](https://www.currency-iso.org/en/home/tables/table-a1.html). In the list, the Minor unit column defines the number of decimals, which determines the smallest unit of a currency. For example, if the currency is USD and the amount is $1.00 (2 decimals), set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1 (0 decimal), set the value of this parameter to 1. More information: - Value range: 1 - unlimited ###### goodsQuantity (Integer) The quantity of the goods. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Value range: 1 - unlimited ##### shipping (Shipping) The shipping information, including the information about the recipient and the carrier.  This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. ###### shippingName (UserName, REQUIRED) The name of the shipping recipient. ###### firstName (String) The first name of the user.  This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 32 characters ###### middleName (String) The middle name of the user. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 32 characters ###### lastName (String) The last name of the user. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 32 characters ###### fullName (String, REQUIRED) The full name of the user. More information: - Maximum length: 128 characters ###### shippingAddress (Address, REQUIRED) The shipping address. ###### region (String, REQUIRED) 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](https://www.iso.org/iso-3166-country-codes.html) standard. More information: - Maximum length: 2 characters ###### state (String) The state, country, or province where the address is located. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ###### city (String) The city, district, suburb, town, or village where the address is located. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ###### address1 (String) The address line 1, which contains the street name, PO box, or company name.  This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 256 characters ###### address2 (String) The address line 2, which contains the apartment, suite, unit, or building name. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 256 characters ###### zipCode (String) The zip or postal code. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 32 characters ###### shippingCarrier (String) The name of the shipping carrier, such as FedEx, UPS, or USPS.  This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 128 characters ###### shippingPhoneNo (String) The contact number of the shipping recipient. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 16 characters ##### buyer (Buyer) The buyer information, including the buyer ID, buyer name, and so on.  This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. ###### referenceBuyerId (String) The unique ID that is assigned by the merchant to identify a buyer. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ###### buyerName (UserName) The name of the buyer. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. ###### firstName (String) The first name of the user.  This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 32 characters ###### middleName (String) The middle name of the user. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 32 characters ###### lastName (String) The last name of the user. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 32 characters ###### fullName (String, REQUIRED) The full name of the user. More information: - Maximum length: 128 characters ###### buyerPhoneNo (String) The contact number of the buyer. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 24 characters ###### buyerEmail (Email) The email address of the buyer. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ##### env (Env) The environment information about the device that is used by the user to place orders. ###### terminalType (String) The type of terminal that is used to initiate the payment.  Valid values are: - `WEB`: indicates that a PC browser is used. - `WAP`: indicates that a mobile browser is used. - `APP`: indicates that a mobile app is used. - `MINI_APP`: indicates that a mini program is used. ###### osType (String) The mobile operating system type. Valid values are: - `IOS`: indicates the iOS system - `ANDROID`: indicates the Android system ###### deviceTokenId (String) The token ID of the client device. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ###### clientIp (String) The IP address of the client device. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ###### cookieId (String) The cookie ID of the user. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 64 characters ###### userAgent (String) The user-agent information. This parameter is specified by Alipay+ if the relevant information is passed in by the merchant. More information: - Maximum length: 1024 characters #### paymentRequestId (String, REQUIRED) The unique ID that is assigned by Alipay+ to identify a payment order. More information: - This field is an API idempotency field.For requests that are initiated with the same paymentRequestId, the MPP must regard the requests as repeated and process the requests only once. The MPP is recommended to check the consistency of the following key request parameters: paymentAmount, payToAmount, surchargeInfo, paymentMethod, and paymentPromoInfo. If any of their values is different from that in the previous request, the MPP needs to return the REPEAT_REQ_INCONSISTENT result code. - Maximum length: 64 characters #### paymentAmount (Amount, REQUIRED) The amount that Alipay+ requests to receive from the MPP. The currency of the amount is the one that Alipay+ uses to create the payment order. If a promotion exists, this amount does not include the promotion amount. For more information about how Alipay+ calculates the different amounts involved in a payment order, see _How are the different amounts calculated_ in the _More information_ section of this topic. ##### currency (String, REQUIRED) The currency code of the amount. The value of this parameter must be an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, for example, "EUR" for Euros. More information: - Maximum length: 3 characters ##### value (Integer, REQUIRED) The value of the amount as a natural number. By default, the value of this parameter is in the smallest currency unit as listed in [the Current Currency & Funds list](https://www.currency-iso.org/en/home/tables/table-a1.html). In the list, the Minor unit column defines the number of decimals, which determines the smallest unit of a currency. For example, if the currency is USD and the amount is $1.00 (2 decimals), set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1 (0 decimal), set the value of this parameter to 1. More information: - Value range: 1 - unlimited #### payToAmount (Amount, REQUIRED) The amount that the MPP settles to Alipay+. The currency of the amount is the MPP's currency. For more information about how Alipay+ calculates the different amounts involved in a payment order, see _How are the different amounts calculated_ in the _More information_ section of this topic. ##### currency (String, REQUIRED) The currency code of the amount. The value of this parameter must be an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, for example, "EUR" for Euros. More information: - Maximum length: 3 characters ##### value (Integer, REQUIRED) The value of the amount as a natural number. By default, the value of this parameter is in the smallest currency unit as listed in [the Current Currency & Funds list](https://www.currency-iso.org/en/home/tables/table-a1.html). In the list, the Minor unit column defines the number of decimals, which determines the smallest unit of a currency. For example, if the currency is USD and the amount is $1.00 (2 decimals), set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1 (0 decimal), set the value of this parameter to 1. More information: - Value range: 1 - unlimited #### paymentQuote (Quote) The exchange rate between _paymentAmount.currency_ and _payToAmount.currency_. This parameter is specified by Alipay+ if _payToAmount_.currency is different from _paymentAmount_._currency_. ##### quoteId (String, REQUIRED) The unique ID that is assigned by Alipay+ to identify an exchange rate. More information: - Maximum length: 64 characters ##### quoteCurrencyPair (String, REQUIRED) 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 `_{base_currency}/{quote_currency}_`, where `_{base_currency}_` and `_{quote_currency}_` are alphabetic codes that follow the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. For example, if the base currency is euro and the quote currency is dollar, the value of this parameter is EUR/USD. Sometimes, the first currency is the order currency and the second currency is the user's payment currency. Sometimes, the sequence is reversed. More information: - Maximum length: 8 characters ##### quotePrice (Decimal, REQUIRED) The quotation of the exchange rate between the currency pair that is specified on the _quoteCurrencyPair_ parameter. **Note**: The value is not always greater than or equal to 1 and has a decimal accuracy of 15 places. More information: - Maximum length: 32 characters ##### quoteStartTime (Datetime) The time when the quotation (specified by the _quotePrice_ parameter) takes effect. More information: - The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard format. For example, "2019-11-27T12:01:01+08:00". ##### quoteExpiryTime (Datetime) The time when the quotation (specified by the _quotePrice_ parameter) expires. More information: - The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard format. For example, "2019-11-27T12:01:01+08:00". ##### baseCurrency (String) The first currency in the currency pair that is specified by the _quoteCurrencyPair_ parameter. The value is an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. More information: - Maximum length: 3 characters ##### quoteUnit (String) The amount in the base currency that is specified by the _baseCurrency_ parameter. More information: - Maximum length: 12 characters #### surchargeInfo (SurchargeInfo) The information about the surcharge that Alipay+ collects on behalf of the MPP after authorization by the MPP. This is a value-added service provided by Alipay+.  For more information about how Alipay+ calculates the different amounts involved in a payment order, see _How are the different amounts calculated_ in the _More information_ section of this topic. This parameter is specified by Alipay+ if the value of _paymentFactor_._needSurcharge_ is `true`. ##### surchargeAmount (Amount, REQUIRED) This parameter specifies the actual amount that is paid by the user when a surcharge exists for the payment order. **Important**: The amount that the MPP settles to Alipay+ is still _payToAmount_. ###### currency (String, REQUIRED) The currency code of the amount. The value of this parameter must be an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, for example, "EUR" for Euros. More information: - Maximum length: 3 characters ###### value (Integer, REQUIRED) The value of the amount as a natural number. By default, the value of this parameter is in the smallest currency unit as listed in [the Current Currency & Funds list](https://www.currency-iso.org/en/home/tables/table-a1.html). In the list, the Minor unit column defines the number of decimals, which determines the smallest unit of a currency. For example, if the currency is USD and the amount is $1.00 (2 decimals), set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1 (0 decimal), set the value of this parameter to 1. More information: - Value range: 1 - unlimited ##### surchargeQuote (Quote, REQUIRED) The exchange rate between _paymentAmount.currency_ and _surchargeAmount.currency_. ###### quoteId (String, REQUIRED) The unique ID that is assigned by Alipay+ to identify an exchange rate. More information: - Maximum length: 64 characters ###### quoteCurrencyPair (String, REQUIRED) 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 _{base\_currency}/{quote\_currency}_, where _{base\_currency}_ and _{quote\_currency}_ are alphabetic codes that follow the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. For example, if the base currency is euro and the quote currency is dollar, the value of this parameter is EUR/USD. Sometimes, the first currency is the order currency and the second currency is the user's payment currency. Sometimes, the sequence is reversed. More information: - Maximum length: 8 characters ###### quotePrice (Decimal, REQUIRED) The quotation of the exchange rate between the currency pair that is specified on the _quoteCurrencyPair_ parameter. **Note**: The value is not always greater than or equal to 1 and has a decimal accuracy of 15 places. More information: - Maximum length: 32 characters ###### quoteStartTime (Datetime) The time when the quotation (specified by the _quotePrice_ parameter) takes effect. More information: - The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard format. For example, "2019-11-27T12:01:01+08:00". ###### quoteExpiryTime (Datetime) The time when the quotation (specified by the _quotePrice_ parameter) expires. More information: - The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard format. For example, "2019-11-27T12:01:01+08:00". ###### baseCurrency (String) The first currency in the currency pair that is specified by the _quoteCurrencyPair_ parameter. The value is an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard. More information: - Maximum length: 3 characters ###### quoteUnit (String) The amount in the base currency that is specified by the _baseCurrency_ parameter. More information: - Maximum length: 12 characters #### paymentMethod (PaymentMethod, REQUIRED) The payment method that is used to collect the payment. For different payment scenarios, the following optional child parameters are also specified by Alipay+ apart from the required child parameters: - For the User-presented Mode Payment scenario,  - _paymentMethod.paymentMethodId_ is specified as the payment code that is presented by the user in the MPP app.  - _paymentMethod.paymentMethodMetaData.paymentCodeRegion_ is specified if the value of the _region_ parameter in the **getPaymentCode** API is specified. - For the Auto Debit scenario, _paymentMethod.paymentMethodId_ is specified as the access token. ##### paymentMethodType (String, REQUIRED) The type of payment method. Sample values include: - `TRUEMONEY`: Indicates the TrueMoney wallet - `ALIPAY_HK`: Indicates the AlipayHK wallet - `TNG`: Indicates the Touch 'n Go eWallet - `ALIPAY_CN`: Indicates the AlipayCN wallet - `GCASH`: Indicates the GCash wallet - `DANA`: Indicates the DANA wallet - `KAKAOPAY`: Indicates the KakaoPay wallet - `RABBIT_LINE_PAY`: Indicates the Rabbit LINE Pay wallet - `BPI`: Indicates the Bank of the Philippine Islands (BPI) - `CONNECT_WALLET`: Indicates the Alipay+ wallets More information: - Maximum length: 32 characters ##### paymentMethodId (String) The unique ID that is assigned by Alipay+ to identify a payment method.  For different payment scenarios, the value of this parameter is specified in different ways. For details, see the note for the parent parameter. Specify this parameter if _paymentMethod.customerId_ and _paymentMethod.paymentMethodMetaData.userLoginId_ are not specified. More information: - Maximum length: 128 characters ##### customerId (String) The unique ID that is assigned by the MPP to identify a user. Specify this parameter if _paymentMethod.paymentMethodId_ and _paymentMethod.paymentMethodMetaData.userLoginId_ are not specified. More information: - Maximum length: 64 characters ##### paymentMethodMetaData (PaymentMethodMetaData) The metadata of the payment method. Specify this parameter if _paymentMethod.customerId_ and _paymentMethod.paymentMethodId_ are not specified. ###### authClientId (String) The unique ID that is assigned by the ACQP to identify an auth client. More information: - Maximum length: 64 characters ###### paymentCodeRegion (String) The source region based on which Alipay+ generates the payment code. Normally the source region refers to the region that is selected by the user in the MPP app. In the User-presented Mode Payment scenario, the value of this parameter is provided by the MPP in its request from the **getPaymentCode** API. As the region that Alipay+ supports is still growing, the MPP should not verify the value of this parameter.  The value of this parameter must be a 2-character country/region code that follows the [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) standard. ###### userLoginId (String) The login ID that is used by the MPP user to log in to the MPP platform. The value of _userLoginId_ can be the user's email address or phone number. With this parameter, the MPP can check whether the user's account supports the payment. Specify this parameter if _paymentMethod.paymentMethodMetaData.userLoginIdType_ is also specified. Otherwise, leave it empty. More information: - Maximum length: 128 characters ###### userLoginIdType (String) The type of method that the MPP user selects to log in to the MPP platform. Valid values are: - MOBILE: indicates that the MPP user logs in to the MPP platform with a phone number. - EMAIL: indicates that the MPP user logs in to the MPP platform with an email address. Specify this parameter if _paymentMethod.paymentMethodMetaData.userLoginId_ is also specified. Otherwise, leave it empty. #### paymentFactor (PaymentFactor, REQUIRED) Factors that impact payment-related items such as the quote price, fee, and regulatory reporting.  The MPP can identify the payment scenario based on the following child parameters:  - _isInStorePayment_ - _isAgreementPayment_ - _isPaymentEvaluation_  For more information, see _How to identify the payment scenarios_ in the _More information_ section of this topic. ##### isInStorePayment (Boolean) Specifies whether the payment scenario is in-store payment. If the value of this parameter is specified as `true`, the payment scenario is in-store payment; otherwise, the payment scenario is online payment. ##### needSurcharge (Boolean) Specifies whether the MPP is to collect a surcharge from the user. If the value of this parameter is specified as `true`, the MPP is to collect a surcharge.  By default, the value of this parameter is `false`. ##### isPaymentEvaluation (Boolean) Specifies whether the payment scenario is payment evaluation for Auto Debit or Cashier Payment. If the value of this parameter is specified as `true`, the request only evaluates whether the user account has sufficient balance to make the payment or the user is KYC compliant, and no funds will be deducted. By default, the value of this parameter is `false`. ##### isCashierPayment (Boolean) Specifies whether a cashier page is presented to the user during the payment. If the value of this parameter is specified as `true`, a cashier page is presented to the user during the payment; otherwise, no cashier page is presented to the user during the payment. ##### isAgreementPayment (Boolean) Specifies whether the payment scenario is Auto Debit. If the value of this parameter is specified as `true`, the payment scenario is Auto Debit; otherwise, the payment scenario is not Auto Debit. ##### inStorePaymentScenario (String) The in-store payment scenario. Valid values are: - `PaymentCode`: indicates the scenario where a user presents a payment code to pay. - `OrderCode`: indicates the scenario where a user scans an order code to pay. - `EntryCode`: indicates the scenario where a user scans an entry code to pay. Note that Alipay+ may not specify this parameter in some scenarios. Do not use this parameter to identify the payment scenario. For more information, see _How to identify the payment scenarios_ in the More information section of this topic. #### paymentExpiryTime (Datetime) The time after which the payment order is expired. If the payment order is not completed before the time that is specified for this parameter, Alipay+ closes the order. This parameter is specified by Alipay+ in all payment scenarios except for when the value of the _paymentFactor.isPaymentEvaluation_ parameter is `true`. More information: - The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard format. For example, "2019-11-27T12:01:01+08:00". #### paymentNotifyUrl (URL) The URL that is used to receive payment result notifications from the MPP. **Important**: In addition to obtaining the notification URL via the API response, the MPP also has access to a default notification URL from Alipay+. The MPP must prioritize using the URL returned by the API for sending payment results, provided it is specified in the API response. More information: - Maximum length: 2048 characters #### paymentRedirectUrl (URL) The URL where the user is redirected to after the payment order is completed.   This parameter is specified by Alipay+ if the user needs to be redirected from the MPP's payment result page to a predetermined page, for example, the merchant result page. More information: - Maximum length: 2048 characters #### paymentPromoInfo (PaymentPromoInfo) The information about the promotion that is applied to the payment order, including the promotion ID, promotion type, and the saved amount after the promotion is applied. This parameter is specified by Alipay+ if a promotion is applied to the payment order. ##### paymentPromoDetails (Array) The details of promotions that are applied to a payment order. ###### promoId (String, REQUIRED) The unique ID that is assigned by Alipay+ to identify a promotion. More information: - Maximum length: 128 characters ###### promoType (String, REQUIRED) The type of promotion. Valid values are: - `INSTANT_DISCOUNT`: indicates that an automatic discount is applied to the user's order - `COUPON`: indicates that a coupon is applied to the user's order ###### promoName (String, REQUIRED) The name of the promotion that is applied to the payment order. More information: - Maximum length: 128 characters ###### savingsAmount (Amount, REQUIRED) The amount that is saved if the promotion is applied to the payment order. The value of _savingsAmount.currency_ is the same as that of _payToAmount.currency_. ###### currency (String, REQUIRED) The currency code of the amount. The value of this parameter must be an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, for example, "EUR" for Euros. More information: - Maximum length: 3 characters ###### value (Integer, REQUIRED) The value of the amount as a natural number. By default, the value of this parameter is in the smallest currency unit as listed in [the Current Currency & Funds list](https://www.currency-iso.org/en/home/tables/table-a1.html). In the list, the Minor unit column defines the number of decimals, which determines the smallest unit of a currency. For example, if the currency is USD and the amount is $1.00 (2 decimals), set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1 (0 decimal), set the value of this parameter to 1. More information: - Value range: 1 - unlimited #### passThroughInfo (String) The information that is passed through by Alipay+ to the MPP. The value of this parameter is in a set of key-value pairs. This parameter is specified by Alipay+ if the ACQP wants to pass information to the MPP. More information: - Maximum length: 20000 characters ## Response parameters #### result (Result, REQUIRED) The result of the business processing, including the result code, result status, and result message. For more information about how to return the result in different payment scenarios, see _How to return the result_ in the _More information_ section of this topic. ##### resultCode (String, REQUIRED) The result code that indicates the detailed processing result. More information: - Maximum length: 64 characters ##### resultStatus (String, REQUIRED) The result status that indicates the processing result. Valid values are: - `S`: Successful - `F`: Failed - `U`: Unknown ##### resultMessage (String) The result message that describes the result code in detail. It is recommended that you return this parameter to provide details about the result. More information: - Maximum length: 256 characters #### paymentId (String) The unique ID that is assigned by the MPP to identify a payment. For the Auto Debit and User-presented Mode Payment scenarios, return this parameter if the value of _result_._resultCode_ is `SUCCESS`, which means that the payment succeeds. More information: - Maximum length: 64 characters #### paymentUrl (URL) The URL where the user is redirected to confirm the payment. More information: - Maximum length: 2048 characters #### paymentTime (Datetime) The date and time when the payment order reaches a final state. For the Auto Debit and User-presented Mode Payment scenarios, return this parameter if the value of _result_._resultCode_ is `SUCCESS`, which means that the payment succeeds. More information: - The value follows the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standard format. For example, "2019-11-27T12:01:01+08:00". #### customerId (String) The unique ID that is assigned by the MPP to identify a user. For the Auto Debit and User-presented Mode Payment scenarios, return this parameter if the value of _result_._resultCode_ is `SUCCESS`, which means that the payment succeeds. More information: - Maximum length: 64 characters #### customsDeclarationAmount (Amount) The maximum amount that is to be declared by the ACQP to customs. The currency of the amount is the currency used by the MPP's user. For example, if the user uses ALIPAY\_CN to pay, the currency is CNY. For the Auto Debit and User-presented Mode Payment scenarios, return this parameter if the value of _result_._resultCode_ is `SUCCESS` and customs declaration is required by the MPP's local authority (for now this only includes the Chinese Mainland). ##### currency (String, REQUIRED) The currency code of the amount. The value of this parameter must be an alphabetic code that follows the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, for example, "EUR" for Euros. More information: - Maximum length: 3 characters ##### value (Integer, REQUIRED) The value of the amount as a natural number. By default, the value of this parameter is in the smallest currency unit as listed in [the Current Currency & Funds list](https://www.currency-iso.org/en/home/tables/table-a1.html). In the list, the Minor unit column defines the number of decimals, which determines the smallest unit of a currency. For example, if the currency is USD and the amount is $1.00 (2 decimals), set the value of this parameter to 100; or if the currency is JPY and the amount is ￥1 (0 decimal), set the value of this parameter to 1. More information: - Value range: 1 - unlimited #### passThroughInfo (String) The information that is passed through by the MPP to Alipay+. The value of this parameter is in a set of key-value pairs. Return this parameter if the MPP wants to pass information to the ACQP. More information: - Maximum length: 20000 characters #### guideUrl (string) The URL that redirects users to a page predefined by the MPP, such as a page for users to perform KYC verification, recharge, or bind cards. Please pay attention to this parameter when the value of _paymentFactor.isPaymentEvaluation_ parameter is `true` and the value of _result.resultStatus_ is `F`.  The MPP can decide whether it needs to return this parameter. More information: - Maximum length: 2048 characters ## More information ### How are the different amounts calculated This section introduces how are _paymentAmount_, _payToAmount_, and _surchargeAmount_ calculated when Alipay+ calls the **pay** API and provides calculation cases to illustrate the process. > **Note**: Alipay+ calculates the values of all amounts in the smallest currency unit. For example, if the currency is HKD and the amount is $1.00, the value of the amount is set to 100; or if the currency is JPY and the amount is ￥1, the value of the amount is set to 1.  #### paymentAmount - _paymentAmount.currency_ = The one that Alipay+ uses to create the payment order. - _paymentAmount.value_ = Payment amount that is requested by the ACQP from Alipay+ - Promotion amount that is provided by Alipay+  - If the promotion amount is in the MPP's currency, the promotion amount is converted to the currency that is used by the ACQP based on _paymentQuote_. #### payToAmount - _payToAmount.currency_ \= The currency that is used by the MPP. - _payToAmount.value_ = Payment amount that is requested by the ACQP from Alipay+ \* _paymentQuote_ - Promotion amount that is provided by Alipay+ - If the promotion amount is in the currency used by the ACQP, the promotion amount is converted to the MPP's currency based on _paymentQuote_. #### surchargeAmount - _surchargeAmount.currency_ = The currency that is used by the MPP. - _surchargeAmount.value_ = Payment amount that is requested by the ACQP from Alipay+ \* _surchargeQuote_ - Promotion amount that is provided by Alipay+ - If the promotion amount is in the currency used by the ACQP, the promotion amount is converted to the MPP's currency based on _surchargeQuote._ #### Calculation cases The following two cases are provided for your reference. #### Case 1 In this case, a Hong Kong user purchases a 1000 JPY merchandise from a Japanese merchant and applies a 5 JPY coupon provided by Alipay+ to the order. Besides, Alipay+ collects a surcharge on behalf of the MPP. **Known conditions** - Initial order amount (_paymentAmount_ specified by the ACQP): 1000 JPY - Instant discount: 5 JPY - Payment quote between JPY and HKD (_paymentQuote_): 1 JPY = 8.5614 HKD - Surcharge quote between JPY and HKD (_surchargeQuote_): 1 JPY = 8.9614 HKD **Calculation results** - _paymentAmount_ = 1000 JPY - 5 JPY = 995 JPY - _savingsAmount =_ 5 JPY \* 8.5614 = 43 HKD - _payToAmount_ = 1000 JPY \* 8.5614 - 5 JPY\* 8.5614 = 8518 HKD - _surchargeAmount_ = 1000 JPY \* 8.9614 - 5 JPY\* 8.9614 = 8916 HKD #### Case 2 In this case, a Hong Kong user purchases a 10000 USD merchandise from an American merchant and applies a 500 HKD coupon provided by Alipay+ to the order. No surcharge is collected. **Known conditions** - Initial order amount (_paymentAmount_ specified by the ACQP): 10000 USD - Instant discount: 500 HKD - Payment quote between USD and HKD (_paymentQuote_): 1 USD = 9.3307 HKD **Calculation results** - _paymentAmount_ = 10000 USD - 500 HKD / 9.3307 = 9946 USD - _savingsAmount_ \= 500 HKD - _payToAmount_ = 10000 USD \* 9.3307 - 500 HKD = 92807 HKD ### How to identify the payment scenarios The following table shows how the key payment factors are specified by Alipay+ for each payment scenario. The MPP can identify which payment scenario is in process according to the configuration of the _paymentFactor_ parameter. | Payment scenario | _isInStorePayment_ | _isAgreementPayment_ | _isPaymentEvaluation_ | | --- | --- | --- | --- | | User-presented Mode Payment | `TRUE` | N/A | N/A | | Auto Debit | N/A | `TRUE` | N/A | | Payment Evaluation for Auto Debit | N/A | `TRUE` | `TRUE` | ### How to return the result For different payment scenarios, according to the business processing result, the MPP needs to return the corresponding result (specified on the result parameter) and specify some optional parameters. **For the Auto Debit and User-presented Mode Payment scenarios:** - If the payment succeeds, set the value of _result.resultStatus_ to `S` and specify the following optional parameters: _paymentId_, _paymentTime_, and _customerId_. - If the payment fails, set the value of _result.resultStatus_ to `F`. - If the payment result is unknown, set the value of _result.resultStatus_ to `U` and the value of _result.resultCode_ to `UNKNOWN_EXCEPTION`. **For the Auto Debit payment evaluation scenario:** - If the payment evaluation result is successful, set the value of _result.resultStatus_ to `S`. - If the payment evaluation result is unsuccessful, set the value of _result.resultStatus_ to `F`. - If the payment evaluation result is unknown, set the value of _result.resultStatus_ to `U` and the value of _result.resultCode_ to `UNKNOWN_EXCEPTION`. ### Samples The samples in the API explorer show how Alipay+ specifies request parameters and how the MPP returns response parameters for different payment scenarios (without promotion). #### Samples with promotion Alipay+ allows you to specify the promotion information in a payment request for the User-presented Mode Payment and Auto Debit scenarios. The following sample code takes the User-presented Mode Payment scenario as an example and shows how to initiate a payment request along with promotion information.  The samples assume that a Korean user purchases a 100 JPY merchandise from a Japanese merchant. The user applies a 10 JPY off 100 JPY coupon provided by Alipay+ and thus actually pays 90 JPY. The payment promotion information is specified for the _paymentPromoInfo_ parameter. 1\. Alipay+ sends a payment request to the MPP.  { "order": { "referenceOrderId": "OrderID\_0100000101", "orderDescription": "SHOES", "orderAmount": { "value": "100", "currency": "JPY" }, "merchant": { "referenceMerchantId": "M00000000001", "merchantMCC": "5411", "merchantName": "UGG", "merchantDisplayName":"UGG", "merchantAddress": { "region": "JP", "city": "xxx" }, "store": { "referenceStoreId": "S0000000001", "storeName": "UGG-2", "storeMCC": "5411" } } }, "acquirerId": "1020000000000000001", "pspId": "1020000000000000001", "paymentRequestId": "2010000000000000000000000007771", "paymentAmount": { "value": "90", "currency": "JPY" }, "paymentMethod": { "paymentMethodType": "CONNECT\_WALLET", "paymentMethodId": "281000000000000000005733", "customerId": "2160000000000001" }, "payToAmount": { "value": "900", "currency": "KRW" }, "paymentQuote": { "quoteId": "1234567", "quoteCurrencyPair": "JPY/KRW", "quotePrice": "10.0000" }, "paymentPromoInfo": { "paymentPromoDetails": \[ { "promoId": "discount\_id\_1", "promoType": "INSTANT\_DISCOUNT", "promoName": "10 JPY off 100 JPY", "savingsAmount": { "value": "100", "currency": "KRW" } } \] }, "paymentFactor": { "isInStorePayment": "true" } } 2\. The MPP returns the response to Alipay+. { "result": { "resultCode": "SUCCESS", "resultStatus": "S", "resultMessage": "success" }, "paymentId": "201000000000000000000000004444", "paymentTime": "2020-01-01T12:01:01+08:30", "customerId": "2160000000000001" } ## Result/Error codes | Code | Value | Message | | --- | --- | --- | | SUCCESS | S | Success | | ACCESS_DENIED | F | The access is denied. | | BUSINESS_NOT_SUPPORT | F | The payment business is not supported. | | CURRENCY_NOT_SUPPORT | F | The currency is not supported. | | EXPIRED_CODE | F | The code is expired. | | INVALID_CLIENT | F | The client is invalid. | | INVALID_CODE | F | The code is invalid. | | INVALID_CONTRACT | F | The contract is invalid. | | INVALID_SIGNATURE | F | The signature is invalid. | | INVALID_TOKEN | F | The access token is invalid. | | KEY_NOT_FOUND | F | The key is not found. | | MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. | | MERCHANT_NOT_REGISTERED | F | The merchant is not registered. | | METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | | NO_INTERFACE_DEF | F | API is not defined. | | ORDER_IS_CLOSED | F | The order is closed. | | PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | | PAYMENT_AMOUNT_EXCEED_LIMIT | F | The payment amount exceeds the limit. | | PAYMENT_COUNT_EXCEED_LIMIT | F | The number of payments exceeds the limit. | | PROCESS_FAIL | F | A general business failure occurred. Don't retry. | | REGULATION_RESTRICTION | F | The payment failed due to regulatory restriction. | | REPEAT_REQ_INCONSISTENT | F | Repeated requests are inconsistent. | | RISK_REJECT | F | The request is rejected because of the risk control. | | UNAVAILABLE_PAYMENT_METHOD | F | The payment method is unavailable. | | USER_AMOUNT_EXCEED_LIMIT | F | The payment amount exceeds the user payment limit. | | USER_BALANCE_NOT_ENOUGH | F | The user balance is not enough for the payment. | | USER_KYC_NOT_QUALIFIED | F | The user is not KYC compliant. | | USER_NOT_EXIST | F | The user does not exist. | | USER_PAYMENT_VERIFICATION_FAILED | F | User fails to pass the payment verification in the methods like OTP, PIN, and so on. | | USER_STATUS_ABNORMAL | F | The user status is abnormal. | | PAYMENT_IN_PROCESS | U | The payment is being processed. | | REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | | UNKNOWN_EXCEPTION | U | An API calling is failed, which is caused by unknown reasons. | ## Request ### USER_PRESENTED MODE PAYMENT ```json { "order": { "referenceOrderId": "OrderID_0100000101", "orderDescription": "SHOES", "orderAmount": { "value": "100", "currency": "JPY" }, "merchant": { "referenceMerchantId": "M00000000001", "merchantMCC": "5411", "merchantName": "UGG", "merchantDisplayName": "UGG", "merchantAddress": { "region": "JP", "city": "xxx" }, "store": { "referenceStoreId": "S0000000001", "storeName": "UGG-2", "storeMCC": "5411" } } }, "acquirerId": "1020000000000000001", "pspId": "1020000000000000001", "paymentRequestId": "2010000000000000000000000007771", "paymentExpiryTime": "2020-01-01T12:01:01+08:30", "paymentAmount": { "value": "100", "currency": "JPY" }, "paymentMethod": { "paymentMethodType": "CONNECT_WALLET", "paymentMethodId": "281000000000000000005733", "customerId": "2160000000000001" }, "payToAmount": { "value": "1000", "currency": "KRW" }, "paymentQuote": { "quoteId": "1234567", "quoteCurrencyPair": "JPY/KRW", "quotePrice": "10.0000" }, "paymentFactor": { "isInStorePayment": "true" } } ``` ### AUTO_DEBIT ```json { "order": { "referenceOrderId": "OrderID_0100000101", "orderDescription": "SHOES", "orderAmount": { "value": "100", "currency": "JPY" }, "merchant": { "referenceMerchantId": "M00000000001", "merchantMCC": "5411", "merchantName": "UGG", "merchantDisplayName": "UGG", "merchantAddress": { "region": "JP", "city": "xxx" } } }, "acquirerId": "1020000000000000001", "pspId": "1020000000000000001", "paymentRequestId": "2010000000000000000000000007771", "paymentExpiryTime": "2020-01-01T12:01:01+08:30", "paymentAmount": { "value": "100", "currency": "JPY" }, "paymentMethod": { "paymentMethodType": "CONNECT_WALLET", "paymentMethodId": "2810000000000000000000000000JWDQ" }, "payToAmount": { "value": "1000", "currency": "KRW" }, "paymentQuote": { "quoteId": "1234567", "quoteCurrencyPair": "JPY/KRW", "quotePrice": "10.0000" }, "paymentFactor": { "isAgreementPayment": "true" } } ``` ### PAYMENT_EVALUATION ```json { "order": { "referenceOrderId": "OrderID_0100000101", "orderDescription": "SHOES", "orderAmount": { "value": "100", "currency": "JPY" }, "merchant": { "referenceMerchantId": "M00000000001", "merchantMCC": "5411", "merchantName": "UGG", "merchantDisplayName": "UGG", "merchantAddress": { "region": "JP", "city": "xxx" } } }, "acquirerId": "1020000000000000001", "pspId": "1020000000000000001", "paymentRequestId": "2010000000000000000000000007771", "paymentAmount": { "value": "100", "currency": "JPY" }, "paymentMethod": { "paymentMethodType": "CONNECT_WALLET", "paymentMethodId": "2810000000000000000000000000JWDQ" }, "payToAmount": { "value": "1000", "currency": "KRW" }, "paymentQuote": { "quoteId": "1234567", "quoteCurrencyPair": "JPY/KRW", "quotePrice": "10.0000" }, "paymentFactor": { "isAgreementPayment": "true", "isPaymentEvaluation": "true" } } ``` ## Response ### USER_PRESENTEDMODE_PAYMENT ```json { "result": { "resultCode": "SUCCESS", "resultStatus": "S", "resultMessage": "success" }, "paymentId": "201000000000000000000000004444", "paymentTime": "2020-01-01T12:01:01+08:30", "customerId": "2160000000000001" } ``` ### AUTO_DEBIT ```json { "result": { "resultCode": "SUCCESS", "resultStatus": "S", "resultMessage": "success" }, "paymentId": "201000000000000000000000004444", "paymentTime": "2020-01-01T12:01:01+08:30", "customerId": "2160000000000001" } ``` ### PAYMENT_EVALUATION ```json { "result": { "resultCode": "SUCCESS", "resultStatus": "S", "resultMessage": "success" } } ```