Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

Buy now pay later

Antom is planning to add some payment methods with the Buy Now Pay Later (BNPL) feature. BNPL is a type of installment loan, which gives a buyer a certain credit line that is long-term effective and recyclable. The buyer can use this credit line for transactions. However, payment methods still need to apply real-time risk control to BNPL transactions to reduce risks on the buyer side and the payment method side, which requires merchants to provide specific information in the API request to Antom. The required information is categorized into basic ones and extended ones, and they have a heavy impact on the success of payments.

Requirements for merchants

Certain parameters are required for the pay API requests. See the following sections for details.

Basic info parameters

Parameters in the following tables are strongly recommended to be passed in by merchants. The risk control of payment methods relies heavily on these parameters. The payment success rate is estimated to rise by 5%~10% if these parameters are provided.

Category

Parameter

Description

order.buyer

referenceBuyerId

OPTIONAL String (64)

The unique ID assigned by the merchant to identify a buyer.

order.goods

goodsName

OPTIONAL String (256)

Goods name.

order.shipping

shippingAddress

OPTIONAL Address

Recipient shipping address. See shippingAddress for details.

Table 1. Basic info parameters

shippingAddress

No.

Field

Description

1

region

REQUIRED String (2)

The two-character ISO 3166 country/region code.

2

state

OPTIONAL String (8)

The state, country, or province.

3

city

OPTIONAL String (32)

The city, district, suburb, town, or village.

4

address1

OPTIONAL String (256)

Address line 1, such as street, PO Box, or company name.

5

address2

OPTIONAL String (256)

Address line 2, such as the apartment, suite, unit, or building information.

6

zipCode

OPTIONAL String (32)

ZIP or postal code.

Table 2. Parameters in shippingAddress

Extended info parameters

Parameters in the following tables are recommended to be passed in by merchants. The payment success rate is estimated to rise by 5% if these parameters are provided.

Category

Parameter

Description

order.goods

referenceGoodsId

REQUIRED String (64)

The unique ID assigned by the merchant to identify the goods.

goodsCategory

OPTIONAL String (64)

A categorization of the goods type.

goodsUnitAmount

REQUIRED Amount

Goods price. See goodsUnitAmount for details.

goodsQuantity

REQUIRED Integer

Goods quantity.

Table 3. Extended info parameters

goodsUnitAmount

No.

Field

Description

1

currency

REQUIRED String (3)

The three-character ISO-4217 currency code.

2

value

REQUIRED Integer

The amount to charge as a positive integer in the smallest currency unit. (That is, 100 cents to charge $1.00, or 100 to charge JPY 100, a 0-decimal currency).

Value range: 1 - unlimited.

Table 4. Parameters in goodsUnitAmount