alipay.acquire.overseas.spot.pay

service

StringRequired

Interface name 

Example:alipay.acquire.overseas.spot.pay

sign

StringRequired

Sign value 

Example:c8il4epm90wyn768fijgqhy8tay37gqa

sign_type

StringRequired

Sign type. RSA, RSA2 and MD5 are supported. Use uppercase. 

Example:MD5

partner

String(16) Required

The partner ID that is assigned by Alipay to identify an Alipay account. The partner ID is composed of 16 digits and begins with 2088. 

Example:2088*********662

_input_charset

String

The charset with which the request data is encoded. UTF-8 is supported.

Example:UTF-8

alipay_seller_id

StringRequired

Alipay seller ID, with the same value of partner ID. 

Example:2088102012343978

quantity

Number

The quantity of goods 

Example:1

trans_name

String(256)Required

The name of the transaction, which is to be shown in the transaction record’s list.

Example:iphone

partner_trans_id

String(64) Required

The unique transaction ID assigned by the partner in the partner system, can be a sale order ID or a payment order ID. 

Example:2010121000000002

currency

String(8) Required

The currency used for labelling the price of the transaction. This is also the settlement currency with which Alipay settles to the partner. Only HKD is supported.

Example:HKD

trans_amount

Number(11,2)

the transaction amount in the currency given above. Range: 0.01-100000000.00. Two digits after decimal point. 

Example:39.25

buyer_identity_code

String(32) Required

A dynamic code with 16 - 24 digits, used to identify Alipay users. This code starts with 25, 26, 27, 28, 29, or 30, and must be read from Alipay wallet of the user in real time.

Example:283323458639276347

identity_code_type

String(16) Required

Identity code type, and the value is barcode 

Example:barcode

trans_create_time

String(16)

The time that the partner system creates the transaction, which is in a format of yyyyMMddHHmmss. SSS±timezone.

Example:20131120153059.782+08:30

memo

String(256)

Transaction notes 

Example:Iphone with special promotion discount

biz_product

String(256)

Required

Product name, with a value of OVERSEAS_MBARCODE_PAY

Example:OVERSEAS_MBARCODE_PAY

extend_info

String(512)

Required

Extended information, which contains extended parameters of the request and is in JSON format. For now it contains the following parameters:

• secondary_merchant_name, which is the secondary merchant name that is to be recorded in the user statement and with a maximum length of 64.
• secondary_merchant_id, which is the secondary merchant ID that is to be used for identifying each specific secondary merchant and the maximum length is 32.
• secondary_merchant_industry, which is the industry classification identifier of the secondary merchant and is allocated by Alipay. The value is a MCC code that is shown in MCC list.
• store_id, which is the unique ID of the merchant store that is assigned by the merchant and with a maximum length of 32.
• store_name, which is the name of the merchant store that is used to be presented in the customer’s Alipay wallet and the reconciliation file. The maximum length is 32.
• terminal_id, which is the terminal ID for submitting the request. This parameter must be transmitted if the immediate promotion rebate is proposed to be used. The maximum length is 10.
• sys_service_provider_id, which is the technical provider ID. This parameter is used to identify the payment system provider. The maximum length is 32.
• terminal_create_time, which is the time when the transaction is created on terminal. Format: yyyyMMddHHmmss.SSS±timezone. The maximum length is 30.

Note:

The following fields are required fields: secondary_merchant_id, secondary_merchant_industry, secondary_merchant_name, store_id and store_name.

Example:{"secondary_merchant_name":"Lotte", "secondary_merchant_id":"123"，"secondary_merchant_industry":"5812","store_id":"A101","store_name":"McDonald in 966 3rd Ave, New York","terminal_id":"212133131","terminal_create_time":20131120153059.782+08:30" }

trade_information

String(6000)

When the Alipay wallet is used, you can specify this field if you want. When the AlipayHK wallet is used, you don’t need to specify this field. (The wallet type is identified by the value of the payment_inst field. ) Information about the trade industry. See trade_information for details. 

Example:{"business_type":"1","hotel_name":"zlidu, sluhg-987, 889utng","check_in_time":"2018-10-20","check_out_time":"2018-10-22"}

notify_url

URL(200)

The URL for receiving asynchronous notifications after the payment is completed.

Example:http://api.test.alipay.net/atinterface/receive_notify.htm

business_type

String

Business type. 5 types are supported:

1: Hotel

2: AIR

3: Overseas study consulting

4: Sales of goods

5: Others, including all the other business types that do not fall into the above 4 categories. For example, mobile data service recharge, airport pick up service, etc.

If more than one type is involved, use the vertical bar to seperate type values.

Example:1|2|3|4|5 or 1

hotel_name

String

Hotel name that consists of numbers, letters, spaces, and special characters including ,.<>()[]/\-,. If more than one hotel name exists, separate values with vertical bar (|). Specify this field only when business_type is 1 (Hotel). 

Example:zlidu, sluhg-987, 889utng

check_in_time

Date

Check-in time. Format: yyyy-MM-dd. Timezone: GMT +8. Specify this field only when business_type is 1 (Hotel). 

Example:2018-10-20

Check-out time. Format: yyyy-MM-dd. Timezone: GMT +8. Specify this field only when business_type is 1 (Hotel). 

Example:2018-10-22

flight_number

String

Flight number. If flight transfer exists, separate flight numbers with vertical bar (|). Specify this field only when business_type is 2 (AIR). 

Example:NWS 996|TWF 8854

Departure time.Format: yyyy-MM-dd HH:mmTimezone: GMT +8. If flight transfer exists, separate time values with vertical bar (|). Specify this field only when business_type is 2 (AIR).

Example:2018-10-22 20:49

admission_notice_url

String

If business_type is 3 (Overseas study consulting), the URL of admission notice (image) must be specified. 

Example:https://www.iconfont.cn/search/index?test

goods_info

String

Goods information that includes SKU names and corresponding quantities, in the format of SKU_name^quantity. If more than one goods exists, separate values with vertical bar (|). Specify this field only when business_type is 4 (Sales of goods).

Example:pencil^2|eraser^5|iPhone XS 256G^1

total_quantity

Number

Total quantities of all goods in one order. Specify this field only when business_type is 4 (Sales of goods). 

Example:8

other_business_type

String

If business_type is 5 (Others), specify the business type in details. 

Example:Airport pick up service

is_success

String(1) Required

Indicates whether the request succeeds or not, with a value of T for success and F for failure. Note: a successful request does not mean the business is accepted and processed successfully. 

Example:T

sign_type

String Required

Sign type. RSA, RSA2 and MD5 are supported. Use uppercase. Note: This field is not returned if the error code is ILLEGAL_SIGN. 

Example:MD5

sign

String(32)

Required

Sign value. This field will not be returned if the error code is ILLEGAL_SIGN

Example:59c7275cf3c82f038b7c0076f9888926

result_code

String(32) Required

Processing result of the request, with a value of SUCCESS, FAILED, or UNKNOWN.

SUCCESS: the payment succeeds

FAILED: the payment is failed. When the value is FAILED, merchants can show the corresponding failure result to the cashier.

UNKNOWN: an unknown result. When the value is UNKNOWN, it is suggested for merchants to cancel the transaction immediately if the transaction is in the offline mode. For transactions in the offline to online mode, query the transaction status with a certain frequency until a clear status is returned, or to cancel the transaction after a certain time.

Example:FAILED

error

String(48)

Error code that is returned when the request is not successful to describe the request failure reason. For more information, see the Error Code section in this document.

Example:INSUFFICIENT_BALANCE

alipay_buyer_login_id

String（64）

Alipay login ID of the buyer, which can be an email address or mobile number. The ID is partially masked for privacy. 

Example:cao@126.com or 186 22156

alipay_buyer_user_id

String(16) Required

The unique ID for each Alipay account, which starts with 2088.

Example:2088102130896433

partner_trans_id

String(64) Required

Equal to the partner_trans_id given in the request

Example:201311221000000002

The transaction ID assigned by Alipay for the partner’s payment request, which follows a mapping relation with the partner field plus the partner_trans_id field.

Example:201311221703338463

The time that the transaction was paid, which is in a format of yyyyMMddHHmmss. 

Example:201311212323

currency

String(8) Required

The currency used for labelling the price of the transaction. 

Example:HKD

trans_amount

Number(11,2)

Required

The transaction amount in the currency given above. Range: 0.01-100000000.00. Two digits after decimal point. 

Example:39.25

payment_inst

String

Identifies the wallet type with a value of ALIPAYCN or ALIPAYHK.

Example:ALIPAYCN, ALIPAYHK

m_discount_forex_amount

Number(9,2)

If coupons/vouchers are used in the transaction, the discount amount redeemed in the settlement currency will be returned. Otherwise, no return. 

Example:2.19

is_success

String(1) Required

Indicates whether the request is accepted by Alipay gateway.

T: accepted

F: rejected

Example:F

sign_type

String 

Required

Sign type. RSA, RSA2 and MD5 are supported. Use uppercase. 

Example:MD5

sign

String(32) Required

Sign value

Example:59c7275cf3c82f038b7c0076f9888926

error

String(48)

Error code that is returned when the request is failed to describe the request failure reason. This field is not returned when result_code is SUCCESS. For more information, see the Error Code section in this document.

Example:INSUFFICIENT_BALANCE

notify_time

Timestamp Required

The time when the notification is sent. The time format is yyyy-MM-dd HH:mm:ss 

Example:2013-11-27 15:45:58

notify_type

String Required

Notification type 

Example:trade_status_sync

notify_id

String Required

Notification ID, used by the partner system to verify the notification 

Example:ac05099524730693a8b330c5ecf72da978

sign_type

String Required

Sign type. RSA, RSA2 and MD5 are supported. Use uppercase.

Example:MD5

sign

String Required

Sign value 

Example:601510b7970e52cc63db0f44997cf70e

notify_action_type

String

Notification action type. The value can be one of the following items:

• createDirectPayTradeByBuyerAction: Create a transaction
• payByAccountAction: Make the payment
• refundFPAction: Make the refund
• reverseAction: Cancel the transaction
• closeTradeAction: Close the transaction
• finishFPAction: Complete the transaction

Example:payByAccountAction

out_trade_no

String

Unique order ID in the order system in the corresponding merchant's website other than Alipay trade number. Uniqueness of this parameter in merchant's website shall be guaranteed. This is a parameter transmitted upon corresponding request, which shall be returned in its original shape.

Example:990xxxxxxx8989

subject

String(256)

Brief description of the transaction.This parameter is in the first column of Alipay trade details and is important for account checking. This parameter is transmitted by the corresponding request and needs to be returned with its original value. 

Example:kids clothing

trade_no

String(64)

The serial number assigned by Alipay to identify a trade in the Alipay system, with a length in the range 16 - 64 bits.

Example:2013112711001004940000394507

trade_status

String

Transaction status. See Trade status for details.

Example:WAIT_BUYER_PAY

gmt_create

Date

The time when the trade transaction is created. Format: yyyy-MM-dd HH:mm:ss. Use GMT+8. 

Example:2013-11-27 15:45:57

gmt_payment

Date

The time when the payment is completed. Format: yyyy-MM-dd HH:mm:ss. Use GMT+8. 

Example:2013-11-27 15:45:57

buyer_email

String

Buyer's Alipay ID, which can be an email address or phone number. 

Example:6xxxxx@qq.com

seller_id

String

Seller's unique Alipay user ID, consists of 16 digits and begins with 2088.

Example:208xxxxxxxxx8155

buyer_id

String

Buyer's unique Alipay user ID, consists of 16 digits and begins with 2088.

Example:208xxxxxxxxx1127

price

Number

Goods price. This parameter is transmitted by the corresponding request and needs to be returned with its original value. 

Example:1.00

quantity

Number

The quantity of goods. This parameter is transmitted by the corresponding request and needs to be returned with its original value. 

Example:10

total_fee

Number(11,2)

Total amount of a transaction in RMB. It is the corresponding parameter upon request, and will be returned back as it is if the currency is RMB.

For a foreign currency, corresponding RMB amount will be calculated based on the exchange rate.

Example:10.00

body

String

Detailed description about the goods. This parameter is transmitted by the corresponding request and needs to be returned with its original value. 

Example:Glitter leggings

refund_fee

Number

The refund amount. The unit is Yuan. 

Example:1.00

paytools_pay_amount

String

Payment amount information of all successful payments in various channels. 

Example:[{"MCARD":"7.94"},{"TMPOINT":"1.69"},{"BANKCARD":"5.55"}]

extra_common_param

String

This parameter is returned with the value of passback_parameters in the corresponding request. 

Example:{"qrcode":"https://qr.alipay.com/9446219319446735"}

m_discount_forex_amount

Number

If coupons/vouchers are used in the transaction, the discount amount redeemed in the settlement currency will be returned. Otherwise, no return. 

Example:2.19

Alipay system is not available. Try again later. Please check whether the network connection is correct, or ask the user to upgrade it to the latest version of Alipay wallet. If you are still unable to use it, try again later. If it still fails, please contact Alipay for investigation.

Parameter value error.

Check each request parameter according to the API specification.

Parameter name error. Check each request parameter according to the API specification. Contact Alipay technical support if this error persists

Ensure that the value of partner parameter matches the partner value provided by Alipay. Contact Alipay technical support if this error persists

Ensure that the service parameter has the same value with the one in API specification. Contact Alipay technical support if this error persists

Contact Alipay technical support.

Ensure that the value of sign_type is among MD5,RSA and RSA2. Contact Alipay technical support if this error persists.

Has no privilege.

Buyer not match. The erchant can ask the user to show or scan the last barcode which is used for the previous payment or the merchant can refresh the partner_trans_id to generate a new payment. If this error persists, contact Alipay technical support for help.

The corresponding trade is closed, and is not allowed for the current operation.  The merchant can generate a new payment.

The entered context contains forbidden words according to China law. The partner needs to check the value of the trans_name parameter.

The value of alipay_seller_id is not correct, therefore, the corresponding account cannot be found. The merchant needs to check if the partner ID is correct.

therefore, the corresponding account cannot be found. The merchant can ask the user to use the other payment method such as cash or the credit card.

For Alipay CN Wallet only, the buyer account has been disabled due to security issues.

1. Users need to complete the real-name validation accordingly

2. Cannot support Hong Kong and Macau residents 3. Cannot support foreign residents

4. User can contact Alipay CS hotline for help

The buyer account is equal to the seller account. Change the user's Alipay account.

Incorrect barcode.
1.Ensure that users are using the correct Alipay barcode or QR code. 

2. Cashier checks whether the scanner is handled correctly.

3. Cashier makes sure not to scan the user's barcode repeatedly.

Trade information is inconsistent. The merchant checks whether the request data equals to the previous one.