alipay.intl.acquiring.offline.pay

Environment

URL

Production

https://open-sea.alipay.com/api/alipay/intl/acquiring/offline/pay.htm

version

String(8) Required

The API version

Example:2.0.4

function

String(128) Required

The API name 

Example:alipay.intl.acquiring.offline.pay

clientId

String(32） Required

The unique ID assigned by Alipay to identify a client that makes API calls 

Example:385xxxxxxxxx0001

reqTime

Datetime Required

Request time. Datetime with timezone, see RFC 3339 Section 5.6 for details.

Example:2001-07-04T12:08:56+05:30

reqMsgId

String(64) Required

Request message ID. The unique ID assigned by the client to identify a request message.

Note: The reqMsgId identifies a unique system request, but it is not used to identify a unique business request.

Example:123xxxxxxxxxxxxxxx3fda

reserve

String(256) Conditional

Reserved parameter. Key-Value formatted parameter for future use. This parameter is required when you are an ISV. If you are an ISV, you need to provide the isvAccesstoken value.

Example:{"isvAccesstoken":123123123sdfsddsf}

signType

String(64)

Sign type. If this field is not specified, RSA2 is used as the sign type.

Example:RSA2

merchantId

String(64) Required

The merchant ID. This parameter identifies the settlement target that Alipay settles to.

Example:211xxxxxxxxxxxxxx2999

productCode

enum<ProductCode>(64) Required

The payment product code. See ProductCode for details.

Example:OFFLINE_PAY

merchantTransId

String(64) Required

Merchant transaction ID. The unique ID assigned by the merchant to identify a transaction.

Example:510xxxxxxxxxxxxx0002

codeType

enum<OfflineCodeType>(32) Required

The code type. See OfflineCodeType for details.

Example:BARCODE

identityCode

String(64) Required

The barcode code value

Example:287xxxxxxxxxx4394

order

Order Required

The order information.

Note: The orderAmount must be provided in the smallest common currency unit. For example, to create a charge for $1.00, you can set orderAmount.value=100 (100 cents). See order for details

Example:{"seller": { "sellerId": "211xxxxxxxxxxxxxx0415", "sellerName": "Zara", "storeName": "Zara-Store #30", "sellerMCC": "5691", "terminalId": "Z98xxxxxx9745", "storeId": "211xxxxxxxxxxxxxx0415" }, "orderAmount": { "currency": "USD", "value": "239" }, "orderDetail": "New White Lace Sleeveless Cute Casual Summer Dresses Vestidos roupas femininas WQW10", "orderTitle": "Women Summer Dress"}

settleContractId

String(64)

The settlement contract ID. The value is defined in the settlement contract. For example, a merchant can have one contract for USD settlement and another one for CAD settlement. If not provided, the default value specified in the settlement contract is used.

Example:USD-1

riskInfo

RiskInfo

Information about the risk. Although this parameter is optional, it is highly recommend to provide this parameter. See RiskInfo for details.

Example:{ "deviceInfo":{ "sessionId":"26dxxxxxxxxxxxxxxxxxxxxxxxxx03e9", "serialNo":"f0xxxc9a", "clientIp":"121.0.29.220", "latitudeLongitude":"39.9151190000,116.4039630000", "idfa":"5D08BADB6-B7D1-46DE-BDAB-B66468A1EFCC", "terminalType":"APP", "deviceName":"Mike's iPhone", "deviceBrand":"APPLE", "deviceModel":"iPhone 7 Plus", "imei":"863360xxxx85012", "osName":"ios", "osVersion":"9.1.1", "wirelessNetwork":"china unicom", "wirelessCarrier":"china unicom", "flightMode":"enabled", "fingerPrintEnabled":"enabled", "deviceBootTime":"2001-07-04T12:08:56+05:30", "lastUnlockTime":"2001-07-04T12:08:56+05:30", "screenResolution":"1024*768", "isJailbreaked":"true", "macAddress":"8c:be:be:71:1f:34", "systemLanguage":"EN", "timeZone":"UTC+11" }, "userInfo":{ "signupTime":"2001-07-04T12:08:56+05:30", "lastLoginTime":"2001-07-04T12:08:56+05:30", "merchantUserId":"user0001" }, "orderInfos":[ { "productName":"iPhone 7", "productCategory":"Phone", "productSubCategory":"smart phone", "itemPrice":{ "currency":"USD", "value":"239" } } ], "riskExtendInfo":"{}"}

notifyUrl

String(1024)Required

Merchant notify URL, which is used for receiving asynchronous notifications after the payment is done.

Example:https://xxxx.xxx.com/jjjj

extendInfo

String(2048)

Extended information. Key-Value formatted parameter for future use. See extendInfo for details.

Example:{\"storeTerminalRequestTime\":\"2019-06-01T12:01:01.379+08:30\",\"Last_payment_info\":\"202001010101050909|2019-06-01T12:01:01.379+08:30\"}

trade_information

String(6000)

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"}

version

String(8) Required

The API version

Example:2.0.4

function

String(128) Required

The API name

Example:alipay.intl.acquiring.offline.pay

clientId

String(32) Required

The unique ID assigned by Alipay to identify a client that makes API calls

Example:385xxxxxxxxx0001

respTime

Datetime

Required

Response time. Datetime with timezone, see RFC 3339 Section 5.6 for details.

Example:2001-07-04T12:08:56+05:30

reqMsgId

String(64) Required

Request message ID. The unique ID assigned by client to identify a request message.

Example:123xxxxxxxxxxxxxxx3fda

reserve

String(256)

Reserved parameter. Key-Value formatted parameter for future use.

Example:{key/value}

resultInfo

ResultInfo Required

Result info. See resultInfo for details.

Example:{ "resultStatus": "S", "resultCodeId": "00000000", "resultCode":"SUCCESS", "resultMsg": "result message" }

acquirementId

String(64) Conditional

Alipay transaction ID. The unique transaction ID assigned by Alipay when the transaction succeeds.

Example:201xxxxxxxxxxxxxxxxxxxxx2747

String(64) Conditional

Merchant transaction ID. The unique ID assigned by the merchant to identify a transaction. Only when the transaction succeeds, this field is returned.

Example:510xxxxxxxxxxxxx1234

orderAmount

Money Conditional

This value must be the same as that of orderAmount passed in the request.This parameter is required when resultInfo.resultCode is SUCCESS. See Money for details.

Example:{"currency":"USD", "value":"239"}

payAmount

Money Conditional

The actual amount the buyer paid.

Note: This parameter is required when resultInfo.resultCode is SUCCESS, and payCurrencyDifferentWithOrderCurrency is true. See Money for details.

Example:{"currency":"CNY", "value":"1481"}

conversionRate

ExchangeRate Conditional

The exchange rate between orderAmount and payAmount.This parameter is required when resultInfo.resultCode is SUCCESS, or payCurrencyDifferentWithOrderCurrency is true. See ExchangeRate for details.

Example:{ "baseCurrency":"USD", "exchangeCurrency":"CNY", "rate":"6.9123" }

createTime

Datetime Conditional

The time when the transaction is created. Datetime with timezone, see RFC 3339 Section 5.6 for details. This parameter is required when resultInfo.resultCode is SUCCESS.

Example:2001-07-04T12:08:56+05:30

paymentTime

Datetime

The payment time of the transaction. This parameter is required when resultInfo.resultCode is SUCCESS. Datetime with timezone, see RFC 3339 Section 5.6 for details.

Example:2018-07-04T12:08:56+05:30

userSite

enum<Site>(64) Required

The payment user site. This parameter is required when resultInfo.resultCode is SUCCESS. See Site for details.

Example:ALIPAY_CN

userId

String(64)

The user ID that identifies a user in the user site.

Example:208xxxxxxxxx9012

userLoginId

String(64)

The ID that the user uses to login to the payment site. The ID is masked to protect the customer privacy.

Example:c***@gmail.com

extendInfo

String(2048)

Extended information. Key-Value formatted parameter for future use.

Example:{"isEnterpriseUser":"true"}

settleOrder

SettleOrder

Conditional

Settlement information. This parameter is returned only when orderCurrency is not the same as settleCurrency. See SettleOrder for details.

Example:{"settleExchangeRate":{"baseCurrency":"HKD","exchangeCurrency":"MOP","rate":"1.03000000"},"settleOrderAmount":{"currency":"HKD","value":"17670"}}

Name

Type

Description

OFFLINE_PAY

String

Offline payment

Name

Type

Description

BARCODE

String

Barcode scene

orderAmount

Money 

Required

The order amount. See Money for details.

Example:{ "value" : "293", "currency" : "CNY" }

orderTitle

String(256) Required

The order title

Example:Women Summer Dress

orderDetail

String(400) Required

The detailed description of the order

Example:New White Lace Sleeveless Cute Casual Summer Dresses Vestidos roupas femininas WQW10.

seller

Seller

Required

The seller information.See seller for details. 

Example:{ "sellerId": "211xxxxxxxxxxxxxx0415", "sellerName": "Zara", "storeName": "Zara-Store #30", "sellerMCC": "5691", "terminalId": "Z98xxxxxx9745", "storeId": "211xxxxxxxxxxxxxx0415" }

deviceInfo

DeviceInfo

Device information. See DeviceInfo for details.

Example:{ "sessionId":"26dxxxxxxxxxxxxxxxxxxxxxxxxx03e9", "serialNo":"f0xxxc9a", "clientIp":"121.0.29.220", "latitudeLongitude":"39.9151190000,116.4039630000", "idfa":"5D08BADB6-B7D1-46DE-BDAB-B66468A1EFCC", "terminalType":"APP", "deviceName":"Mike's iPhone", "deviceBrand":"APPLE", "deviceModel":"iPhone 7 Plus", "imei":"863xxxxxxxx5012", "osName":"ios", "osVersion":"9.1.1", "wirelessNetwork":"china unicom", "wirelessCarrier":"china unicom", "flightMode":"enabled", "fingerPrintEnabled":"enabled", "deviceBootTime":"2001-07-04T12:08:56+05:30", "lastUnlockTime":"2001-07-04T12:08:56+05:30", "screenResolution":"1024*768", "isJailbreaked":"true", "macAddress":"8c:be:be:71:1f:34", "systemLanguage":"EN", "timeZone":"UTC+11"}

userInfo

UserInfo

Information about the user. See UserInfo for details.

Example:{ "signupTime":"2001-07-04T12:08:56+05:30", "lastLoginTime":"2001-07-04T12:08:56+05:30", "merchantUserId":"user0001"}

orderInfos

List<OrderInfo>

Transaction information. See OrderInfo for details.

Example:[ { "productName":"iPhone 7", "productCategory":"Phone", "productSubCategory":"smart phone", "itemPrice":{ "currency":"USD", "value":"239" } }]

riskExtendInfo

String(2048)

Risk extend information. Key-Value formatted parameter for future use.

Example:{Key/Value}

sessionId

String(64)

The session ID that identifies the device, can be obtained from the integrated Alipay device fingerprint SDK.

Example:26dxxxxxxxxxxxxxxxxx7xxxxxxx03e9

serialNo

String(64)

Serial number of the device.

Note: It is recommended to provide this parameter, although it is optional.

Example:f0cxec9a

clientIp

String(32)

Client IP address.

Note: It is recommended to provide this parameter, although it is optional.

Example:121.0.29.220

latitudeLongitude

String(128)

Latitude and longitude of the user's request to the merchant.

Note: It is recommended to provide this parameter, although it is optional.

Example:39.9151190000,116.4039630000

idfa

String(128)

Advertising identifier.

Note: It is recommended to provide this parameter, although it is optional.

Example:5D08BADB6-B7D1-46DE-BDAB-B66468A1EFCC

terminalType

enum<TerminalType>(32)

Terminal type. See TerminalType for details.

Example:APP

deviceName

String(256)

Device name

Example:Mike's iPhone

deviceBrand

String(256)

Device brand

Example:APPLE

deviceModel

String(64)

Device model

Example:iPhone 7 Plus

imei

String(64)

International mobile equipment identity

Example:863xxxxxxxx5012

osName

String(64)

Operating system name 

Example:ios

osVersion

String(32)

Operating system version

Example:9.1.1

wirelessNetwork

String(128)

Wireless network

Example:china unicom

wirelessCarrier

String(128)

Wireless carrier name 

Example:china unicom

flightMode

String(32)

Specifies whether the flight mode is enabled or not

Example:enabled

fingerPrintEnabled

String(32)

Specifies whether the finger print is enabled or not

Example:enabled

deviceBootTime

Datetime

The boot time of the device

Example:2001-07-04T12:08:56+05:30

lastUnlockTime

Datetime

The last unlock time of the device

Example:2001-07-04T12:08:56+05:30

screenResolution

String(32)

The resolution of the device screen

Example:1024*768

isJailbreaked

Boolean(32)

Specifies whether the device is jailbreaked or not

Example:true

macAddress

String(64)

Mac address

Example:8c:be:be:71:1f:34

systemLanguage

String(64)

Device system language

Example:EN

timeZone

String(32)

Time zone in device settings

Example:UTC+11

signupTime

Datetime

The user signup time, in a format of datetime with timezone that follows the ISO-8601 standard. See RFC 3339 Section 5.6 for details. 

Example:2001-07-04T12:08:56+05:30

lastLoginTime

Datetime

Merchant user last login time, in a format of datetime with timezone that follows the ISO-8601 standard. See RFC 3339 Section 5.6 for details. 

Example:2001-07-04T12:08:56+05:30

merchantUserId

String(64)

The user ID in the merchant system

Example:user0001

productName

String(64)

The product name

Example:iPhone7

productCategory

String(64)

The category that the product belongs to

Example:Phone

productSubCategory

String(64)

The subcategory that the product belongs to 

Example:Smartphone

itemPrice

Money

Item price. See Money for details 

Example:{ "value" : "297", "currency" : "CNY" }

Name

Type

Description

APP

String

Mobile application

WEB

String

Browser web

WAP

String

Mobile wap

SYSTEM

String

System call

APP_LINK

String

Direct jump to mobile app through universal link

sellerId

String(32) Required

The seller ID

Example:201xxxxxxx0012

sellerMCC

String(32) Required

The merchant industry. See Merchant category code for details.

Example:5691

sellerName

String(128) Required

The seller name

Example:Sara

sellerEngName

String(256)

The English name of the seller

Example:Sara

storeId

String(32) Required

The store ID 

Example:123324

storeMCC

String(32) Required

The merchant category code of the store. See Merchant category code for details

Example:1232

storeName

String(128) Required

The name of the store

Example:new store

storeEngName

String(256)

English name of the store

Example:new store

terminalId

String(64)

The POS terminal ID

Example:tid-3489439085

operatorId

String(64)

The operator ID

Example:Juliet-001

currency

String(3) Required

The 3-letter currency code. See supported currencies for details 

Example:USD

value

Number(16) Required

The amount. This value must be provided in the smallest common currency unit. For example, to create a charge for $1.00, you can set orderAmount: value=100 (100 cents) 

Example:239

storeTerminalRequestTime

String

The time when the transaction is created on terminal. Format: yyyy-MM-ddTHH:mm:ss.SSS ± timezone

Example: 2019-06-01T12:01:01.379+08:30

last_payment_info

String

Information about the previous one payment. The information includes alipay_trans_id and the time when the merchant receives the response from Alipay, which are separated by a vertical bar (|).

Example: 202001010101050909|2019-06-01T12:01:01.379+08:30

business_type

String

Business type. 5 types are supported.1: Hotel2: AIR3: Overseas study consulting4: Sales of goods5: 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, separate type values with vertical bar (|). 

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

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

Date

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

Date

Departure time. Format: yyyy-MM-dd HH:mm. Timezone: 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

resultStatus

String(2) Required

The request status can be:S: successF: failureU: unknown

Example:S

resultCodeId

String(8) Required

An 8-digit code that is used to identify a result. When resultStatus is S, the value must be 00000000. When resultStatus is F or U, the value can be other result ID specified by the interface.

Example:00000000

resultCode

String(64) Required

The result code

Example:SUCCESS

resultMsg

String(256)

Result message. When resultCode is S, this value can be empty. When resultCode is F or U, the error description is required.

Example:success

baseCurrency

String(3) Required

The base currency

Example:USD

exchangeCurrency

String(3) Required

The exchange currency

Example:CNY

rate

String(16) Required

The exchange rate of baseCurrency against exchangeCurrency

Example:6.9123

Name

Type

Description

ALIPAY_CN

String

Alipay site for Chinese mainland

ALIPAY_HK

String

Alipay site for Hong Kong, China

KAKAOPAY

String

Kakao Pay 

TNG

String

Touch'n Go eWallet

settleExchangeRate

SettleExchangeRate 

Required

Settle exchange rate information. See SettleExchangeRate for details.

Example:{"baseCurrency":"HKD","exchangeCurrency":"MOP","rate":"1.03000000"}

settleOrderAmount

Money 

Required

Merchant settlement amount and currency. See Money for details.

Example:{"currency":"HKD", "value":"17670"}

extendInfo

String(2048)

Extended information. The key-value formatted parameter reserved for future use.

Example:{key/value}

baseCurrency

String(3) 

Required

The base currency.

Example:HKD

exchangeCurrency

String(3)

Required

The exchange currency.

Example:MOP

rate

String(16)

Required

The exchange rate of baseCurrency against exchangeCurrency.

Example:1.03000000

resultCodeId

resultCode

resultStatus

Remarks

00000025

REPEAT_REQ_INCONSISTENT

F

Repeated or inconsistent requests

00000011

RISK_REJECT

F

The payment is declined because of risk control

12002005

USER_NOT_EXIST

F

The user does not exist

12002006

USER_STATUS_ABNORMAL

F

Abnormal user status

12005001

CURRENCY_NOT_SUPPORT

F

The transaction currency is not supported. See supported currencies for details

12005104

AMOUNT_EXCEED_LIMIT

F

The amount exceeds the limit

12005128

COUNT_EXCEED_LIMIT

F

The count exceeds the limit

12006004

USER_BALANCE_NOT_ENOUGH

F

Insufficient user balance

12005131

IDENTITY_CODE_INVALID

F

The identityCode is invalid

12005132

IDENTITY_CODE_NOT_SUPPORT

F

The format of the identity code is NOT supported. For example, the identity code is from an unsupported wallet

12005124

PAYMENT_IN_PROCESS

U

The payment is still in process

12005100

ORDER_IS_CLOSED

F

The transaction status is closed

12005003

ORDER_STATUS_INVALID

F

The transaction status is invalid

12002046

USER_AMOUNT_EXCEED_LIMIT

F

The user amount exceeds the limit

12002004

USER_REALNAME_STATUS_INVALID

F

The user needs to complete the real name authentication

12002010

USER_NO_PAYMENT_INSTRUMENT

F

No payment instrument is applicable

12005134

SIGN_TYPE_INVALID

F

The signature type is invalid

resultCodeId

resultCode

resultStatus

Remarks

00000000

SUCCESS

S

Success

00000019

PROCESS_FAIL

F

General business failure

00000901

UNKNOWN_EXCEPTION

U

API failed because of unknown reasons

00000004

PARAM_ILLEGAL

F

The parameter is incorrect

00000007

INVALID_SIGNATURE

F

The signature is invalid

00000008

KEY_NO_FOUND

F

The key is not found

00000013

NO_INTERFACE_DEF

F

The API is undefined

00000014

API_IS_INVALID

F

The API is invalid or nonactivated

00000021

ACCESS_DENIED

F

Access denied

12014155

UNKNOWN_CLIENT

F

Unknown client

12014156

INVALID_CLIENT_STATUS

F

Invalid client status

00000024

REQUEST_TRAFFIC_EXCEED_LIMIT

F

The request traffic exceeds the limit

12003001

MERCHANT_NOT_EXIST

F

The merchant doesn't exist