alipay.acquire.overseas.query

Environment

HTTPS request URL

Production environment

https://api-sea-global.alipayplus.com/gateway.do

Parameter

Description

Basic parameter

service

String Required

Interface name

Example:alipay.acquire.overseas.query

sign

String Required

Sign value

Example:c8il4epm90wyn768fijgqhy8tay37gqa

sign_type

String Required

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

Example:RSA2

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 or 2160.

Example:2160*********662

_input_charset

String

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

Example:UTF-8

Operation parameter

partner_trans_id

String(64) Required

The original partner transaction ID given in the payment request

Example:2010121000000002

alipay_trans_id

String(64)

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

Parameter

Description

is_success

String(1) Required

Indicates whether the request is accepted by the Alipay gateway.

T: accepted

F: rejected

Example:T

sign_type

String Required

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

Example:RSA2

sign

String(32)

Required

Sign value

Example:59c7275cf3c82f038b7c0076f9888926

payment_inst

String(32)

Required

This parameter identifies the wallet type with a value of ALIPAYCN or ALIPAYHK.

Example:ALIPAYHK

result_code

String(32)

Required

Processing result of the request, with a value of SUCCESS to indicate the process is successful, or FAIL to indicate the process is failed.

Example:SUCCESS

error

String(48)

Error code that is returned when the request is not successful, 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:TRANS_NOT_FOUND

alipay_trans_status

String(32)

Transaction status. See Trade status for details.

Example:WAIT_BUYER_PAY

alipay_buyer_login_id

String(20)

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 field given in the request

Example:201311221000000002

alipay_trans_id

String(64)

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

alipay_pay_time

String(16)

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

Example:201311212323

currency

String(8)

Required

The currency used for labeling 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

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

Parameter

Description

is_success

String(1) Required

Indicates whether the request is accepted by the Alipay gateway.

T: accepted

F: rejected

Example:F

sign_type

String Required

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

Example:RSA2

sign

String(32) Required

Sign value

Example:59c7275cf3c82f038b7c0076f9888926

detail_error_code

String(48)

Detailed error code, which describes the reason for the response code returned. If the response code of result_code is SUCCESS, this parameter is not returned. 

Example:TRANS_NOT_FOUND

detail_error_des

String(48)

Explanation of the detailed error code. If result_code is SUCCESS, this parameter is not returned.

Example:New parameter??? needs to get list from Dev team

Error code

Description

SYSTEM_ERROR

Alipay system is currently not available. Try again later.

ILLEGAL_SIGN

Illegal signature. Use a legal signature and try again.

INVALID_PARAMETER

Parameter value error. Check the standard of each request parameter according to the API speficaition

ILLEGAL_ARGUMENT

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

ILLEGAL_PARTNER

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

ILLEGAL_EXTERFACE

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

ILLEGAL_PARTNER_EXTERFACE

Partner ID do not have access privilege. Contact Alipay technical support.

ILLEGAL_SIGN_TYPE

Illegal sign type. Ensure that the value of sign_type is MD5, RSA or RSA2. Contact Alipay technical support if this error persists

HAS_NO_PRIVILEGE

Has no privilege. Contact Alipay technical support.

REASON_TRADE_BEEN_FREEZEN

Corresponding trade is been frozen due to security issues. Contact Alipay technical support.

TRADE_NOT_EXIST

Cannot find corresponding trade according to the value of partner_trans_id. Ensure the partner_trans_id is correct. Contact Alipay technical support