- [Introduction](./1) - [Payment Flow and User Experience](./3) - [Quick start](./64) - [Pay Flow](./57) - [Refund Flow](./58) - [Query Flow](./59) - [Reconciliation Flow](./67) - [Secondary Merchant Maintenance Flow](./68) - [Integration](./42) - [Preparing keys](./48) - [Downloading Demo Code](./66) - [Calling APIs](./65) - [Creating the Pre-sign String](./75) - [Signing the Request and Creating the Request URL](./50) - [Processing Notifications](./51) - [Verifying the Asynchronous Notification](./52) - [Verifying the Synchronous Notification](./53) - [Testing in Sandbox](./44) - [Prerequisites](./43) - [Deploying in Sandbox](./45) - [Running Demo Code in Sandbox](./46) - [Going Live](./55) - [API list](./6) - [Create_forex_trade](./6) - [Request Parameters](./6) - [Sync Response](./7) - [Samples](./8) - [Async Notification](./9) - [Error Codes](./10) - [Change History](./74) - [Forex_refund](./11) - [Request Parameters](./11#Request) - [Sync Response](./11#Response) - [Samples](./11#Samples) - [Error Codes](./12#Errors) - [Async Notification](./70) - [Single_trade_query](./13) - [Request Parameters](./13#QueryRequest) - [Sync Response](./13#QueryResponse) - [Samples](./13#QuerySamples) - [Error Codes](./14#Errors) - [Forex_compare_file](./15) - [Request Parameters](./15#Forex_compare_file_Request) - [Sync Response](./15#Forex_compare_file_Response) - [Samples](./15#Forex_compare_file_Samples) - [Error Codes](./16) - [Forex_liquidation_file](./17) - [Request Parameters](./17#Forex_liquidation_file_Request) - [Sync Response](./17#Forex_liquidation_file_Response) - [Samples](./17#Forex_liquidation_file_Samples) - [Error Codes](./18) - [Forex_rate_file](./19) - [Request Parameters](./19#Forex_rate_file_Request) - [Sync Response](./19#Forex_rate_file_Response) - [Samples](./19#Forex_rate_file_Samples) - [Error Codes](./20) - [alipay.overseas.secmerchant.online.maintain](./37) - [Request Parameters](./37#request) - [Sync Response](./37#sync) - [Samples](./37#samples) - [Error Codes](./37#error) - [Change History](./37#history) - [alipay.overseas.secmerchant.maintain.queryStatus](./73) - [Request Parameters](./73#request) - [Sync Response](./73#sync) - [Samples](./73#samples) - [Error Codes](./73#error) - [Change History](./73#history) - [Reconciliation files](./34) - [Obtaining Reconciliation Files](./35) - [API](./35#API) - [Alipay global site](./35#Global) - [SFTP](./35#SFTP) - [Reconciliation File Contents](./36) - [Transaction file](./36#TransactionFile) - [Settlement file](./36#SettlementFile) - [Digital Signature](./69) - [Preparing Keys](./48) - [Creating the Pre-sign String](./75) - [Signing the Request](./50) - [Verifying the Signature of Asynchronous Response](./52) - [Verifying the Signature of Synchronous Response](./53) - [FAQ](/help/online)
New Cross-border Website Payment

Query Flow

You can query a transaction by sending a query request.

The query service name is: single_trade_query.

To verify whether all API requests and responses are correctly handled, and whether user experiences are as expected, you can test Alipay payment features integrated with your applications in sandbox environment before going live in the production environment.

Sandbox environment is an environment where you can mimic the characteristics of the production environment and create simulated responses from all APIs the application relies on before going live. You can make API tests based on your own requirements including making a transaction, cancel, or refund a transaction, and so on. Before you access the Alipay Sandbox Portal to start the test, you need to make some preparations. See Prerequisites for details.

Before you test Alipay payment features in sandbox, you need to get the following preparations:

Creating an Alipay merchant account:

  1. Go to the Alipay for Business website: https://global.alipay.com
  2. In the top-right corner of the homepage, click Sign Up.
  3. Enter your email, enter the code displayed, and then click Continue.
  4. Follow the instructions to complete the account creation.

Use your merchant account to log in to the Alipay Sandbox Portal, if you don’t have the account, see Prerequisites.

Alipay sandbox gateway

Use the Alipay sandbox gateway for testing. The URL of the sandbox gateway is:

Alipay sandbox test accounts

There are two types of test account: merchant test account and buyer test account.

Merchant test accounts:

Find the merchant test account information in the Alipay sandbox portal under Sandbox Accounts > Merchant. More than one test accounts are provided, and the accounts are sorted by payment feature. Find the correct one to use according to the payment feature you want to test. For example, to test the Alipay Auto Debit feature, use the account information provided under Alipay Auto Debit.

  • Login password: Use this password to login to the Alipay for Business website in the sandbox environment.
  • Signature key: Only MD5 signature is supported in the sandbox environment. RSA signature is not supported at this time.

    For more information about the MD5 signature, see Digital Signature.

Buyer test account:

Use the buyer test account to login to the Alipay sandbox app.
The buyer test account information can be found in the Alipay sandbox portal under Sandbox Accounts > Buyer.

Account balance: You can click Top Up to top up the buyer test account.

Download the Alipay sandbox app

The Alipay sandbox app supports only Android at this time.

1) In the Alipay sandbox portal, click Alipay Sandbox App from the menu on the left.
2) Take one of the following steps:

To log in to the Alipay sandbox app, use the buyer test account and login password that are provided in the portal under Sandbox Accounts > Buyer.

To generate a digital signature, normally a key is required to sign the data. You must prepare the MD5 private key or the RSA/DSA private and public key pair to generate and verify a digital signature.

MD5 sign type

MD5 private key is required for generating and verifying MD5 signatures. The MD5 secret key is the 32-byte string which is composed of English letters and numbers. You can log in to the Global Portal to view the private key:

  1. Log in with your user ID.
  2. Click My Technical Service and enter your payment password. If you don't know your payment password, please contact Global Merchant Business Support
  3. Check your MD5 Key. For example, the following graphic is an example of an MD5 Key:

RSA/DSA sign type

An RSA/DSA key pair contains the private key and the public key. The private key is required for generating the signature, while the public key is used for verifying the signature. The following steps assume that you are using RSA sign type, similar steps applied for generating and uploading DSA key pair.

Generating the private/public key pair

Many tools can be used to generate the RSA key pair. The following example illustrates the steps to generate the RSA key pair by using OpenSSL.

  1. Install OpenSSL
    • For linux system, use the following command:
      sudo apt-get install openssl
    • For windows system, download and then install OpenSSL from OpenSSL site.
  2. Generate RSA key pair.
    For linux system, use the following command:
    $ openssl
    OpenSSL> genrsa -out rsa_private_key.pem 1024 ##generating  private key
    OpenSSL> pkcs8 -topk8 -inform PEM -in rsa_private_key.pem  -outform PEM -nocrypt ##transform private key into PKCS8 format
    OpenSSL> rsa -in rsa_private_key.pem -pubout -out  rsa_public_key.pem ##Generate public key
    OpenSSL> exit          

    For windows system, use the following command:
    C:\Users\Hammer>cd C:\OpenSSL-Win32\bin ##enter OpenSSL directory
    C:\OpenSSL-Win32\bin>openssl.exe ##enter OpenSSL
    OpenSSL> genrsa -out rsa_private_key.pem 1024  ##generating private key
    OpenSSL> pkcs8 -topk8 -inform PEM -in rsa_private_key.pem  -outform PEM -nocrypt ##transform private key into PKCS8 format
    OpenSSL> rsa -in rsa_private_key.pem -pubout -out  rsa_public_key.pem ##Generate public key
    OpenSSL> exit 

After that, you can see two files under current folder, rsaprivatekey.pem and rsapublickey.pem. The former is the private key and the latter is the public key.


The following are the examples of the key pair:

Exchange the public key

You need to exchange your public key with Alipay. Contact Global Merchant Technical Support and provide your PID and public key information. Alipay will then make configurations accordingly, and provide you Alipay public key.

For a transaction that has been successfully paid, the customer can request the merchant for refunding as long as the refunding period is still valid, and the merchant can make use of the refunding interface to complete the refunding, as illustrated.

For the integration of the refunding service, we would like to highlight:

  1. The refunding service name is: alipay.acquire.overseas.spot.refund(REFUND);
  2. To refund a transaction, the interface REVERSE is only applicable at the same day of the payment (GMT +8, Beijing time); on the other hand, the interface REFUND is applicable as long as the refunding period has not expired yet;
  3. the refunding of a transaction can be full or partial, i.e. the refunding amount can respectively be the same as or less than the original transaction amount that has been paid; furthermore, for a transaction, multiple refunding request is allowed provided the sum of the amount of the multiple refunding request is less than or equal with the original transaction amount. 

Except for "sign" and "sign_type", all other parameters used need to be signed.

Generating the pre-sign string for request

For the following parameter array:

string[]  parameters={"partner=\"208861122157****\"",
Combine all array values in the format of key= “value” and then link them up by the character “&” in an alphabetical order. For example:


Generating the pre-sign string for synchronous notification

The following sample illustrates the content of a synchronous notification:


Take out the part of result, remove "sign" and "sign_type" parameters:


Generating the pre-sign string for asynchronous notification

The following sample illustrates the contents of an asynchronous notification:

http://0ee96cd2.ngrok.io/notify.htm? buyer_id=208812287878****¤cy=HKD&forex_rate=0.85420000¬ify_id=e5f5c6a77034fcd111e373e7e61dcbegdy¬ify_type=trade_status_sync¬ify_time=2017-08-11 17:31:39&out_trade_no=0811172929-1013&rmb_fee=0.09&seller_id=208861122157****&trade_no=2017081121001003050274536539&total_fee=0.10&trade_status=TRADE_FINISHED&sign_type=RSA&sign=$$$

Remove sign and sign_type, sort other parameters in alphabetical order, and then link up all array values by the character of “&”:

buyer_id=208812287878****¤cy=HKD&forex_rate=0.85420000¬ify_id=e5f5c6a77034fcd111e373e7e61dcbegdy¬ify_type=trade_status_sync¬ify_time=2017-08-11 17:31:39&out_trade_no=0811172929-1013&rmb_fee=0.09&seller_id=208861122157****&trade_no=2017081121001003050274536539&total_fee=0.10&trade_status=TRADE_FINISHED

  • Parameters without value don't need to be transmitted, nor to be included in the data to be signed;
  • At signing, the character set used to change the character into byte stream must be consistent with that specified in _input_charset;
  • If the parameter _input_charset is transmitted, it shall also be included in the data to be signed.
MD5 sign type

After the pre-sign string is generated:

  1. Append the MD5 secret key to the pre-sign string to generate a new string.
  2. Calculate the new string with the MD5 signature algorithm (by using the MD5 signature function).
The result 32-byte string is the signature, which is used as the value of the “sign” parameter.

RSA/DSA sign type

After the pre-sign string is generated, perform the following steps to generate the signature:

  1. Use the RSA/DSA algorithm and the merchant private key to generate the signature.
  2. Encode the signature to a string.
Then, use the string as the value of the “sign” parameter.

MD5 sign type

After receiving the character string of the response or notification from Alipay system, similar to the steps taken in Signing the data, append the MD5 secret key to the character string to generate a new string. Then, calculate this new string with the MD5 signature algorithm. After the 32-byte signature result string is generated, verify whether the value is equal to the value passed in the sign parameter. If Yes, the verification is passed.

RSA/DSA sign type

After receiving a response or notification, perform the following steps to verify the signature:

  1. Generate the pre-sign string as described in Generating Pre-sign String.
  2. Use the RSA/DSA algorithm to calculate a message digest.
  3. Use the RSA/DSA public key to de-sign the signature (the value of the sign field) to a message digest.
  4. Compare the two message digests obtained in step 2 and step 3. If the digests are the same, then it indicates that the signed data has not been changed.

The gateway URL:

Environment HTTPS request URL
Production environment https://intlmapi.alipay.com/gateway.do
Test environment https://mapi.alipaydev.com/gateway.do

If you want to use Alipay sandbox to test the integration, see the sandbox handbook for details.