Create Payment Link

Idempotency

Use requestId to identify a create request. Reuse the same requestId when the outcome is unknown.
A duplicate requestId returns ODR00000040; it does not return the original Payment Link. Query
POST /v1/stable/collect/payment-links with the same requestId to recover the result.

userOrderNo is deprecated. If requestId is blank, userOrderNo will be used as the requestId.
If both are provided, requestId takes precedence.

Amount tolerance

By default a payment must match the expected amount exactly. Supply amountTolerance on a One-Time
link to accept a payment that lands within a band around the expected amount. The band is two-sided:
both underpayment and overpayment inside the band are matched.

`mode`	Extra field	Accepted range
`NONE`	—	exactly the expected amount
`PERCENTAGE`	`percentage`	expected amount ± (expected amount × `percentage`)
`FIXED`	`fixedAmount`	expected amount ± `fixedAmount`

mode is uppercase and case-sensitive, unlike paymentLinkType. Set at most one of percentage and
fixedAmount; the value must be positive. Both are capped by a platform limit, and fixed-amount
tolerance additionally has to be enabled for the currency.

Tolerance is not available on Permanent links.

When an accepted payment is below the expected amount, the platform fee is scaled down in proportion
to the amount actually received and the merchant is credited with the remainder. Overpayment above
the expected amount is routed to the excess-funds flow rather than credited to the order.

The response always echoes the effective configuration. A link created without tolerance returns
"amountTolerance": { "mode": "NONE" }.

Deposit addresses

addressList is returned only to merchants for whom address pre-allocation is enabled. For those
merchants a One-Time crypto-priced link with a concrete supportCurrency is activated at creation
and its deposit addresses are returned immediately, one entry per eligible chain. Every other
merchant, and every link that is not eligible for pre-allocation, keeps the hosted checkout flow and
receives no addressList.

When an entry carries a memo, the payer must include it or the deposit cannot be matched.

Error codes

Business failures return status 500 and an ODR-prefixed code (OrderErrorCode). These are not
8-digit numbers like the Wallet APIs.

`code`	Meaning
`ODR00000040`	Duplicate `requestId` — a Payment Link already exists for it
`ODR00000041`	A parameter was rejected
`ODR00000042`	`amountTolerance.percentage` and `amountTolerance.fixedAmount` were both supplied
`ODR00000043`	The tolerance exceeds the platform limit, or fixed-amount tolerance is not enabled for that currency
`ODR00000044`	`amountTolerance` was supplied on a link that is not One-Time
`ODR00000045`	Address pre-allocation is enabled for the merchant but no deposit address was available on any eligible chain

ODR00000041 covers every parameter check on this endpoint. It is returned when:

Condition
`paymentLinkType` is `ONETIME` and `paymentValidTime` is missing or not positive
crypto collection without `targetAccountId`
`targetAccountId` does not resolve to an active wallet
`supportCurrency` is `ALL` on a One-Time link
fiat collection with `fiatAmount` missing or not positive
One-Time crypto link with `cryptoAmount` missing or not positive
the amount is below the minimum receive amount for that currency
`supportCurrency` or `supportNetwork` is blank
`supportCurrency` is `ALL` combined with a specific `supportNetwork`
`supportCurrency` is not a platform-supported currency
`supportNetwork` is not among the networks allowed for that currency
`payerInfo` is omitted
`payerInfo.userType` is absent while `payerNameUnavailable` is false
an individual payer is missing `firstName` or `lastName`
a corporate payer is missing `companyName`
`payerInfo.userType` is neither `individual` nor `corporate`
`paymentLinkType` is not recognised
the business type is not recognised
`amountTolerance.mode` is `PERCENTAGE` and `percentage` is missing or not positive
`amountTolerance.mode` is `FIXED` and `fixedAmount` is missing or not positive

API Key

Add parameter in header

API-KEY

Example:

API-KEY: ********************

API Key

Add parameter in header

API-SIGNATURE

Example:

API-SIGNATURE: ********************

API Key

Add parameter in header

API-TIMESTAMP

Example:

API-TIMESTAMP: ********************

application/json

Bodyapplication/json

Example

{
    "status": 200,
    "code": "SUCCESS",
    "msg": "ok",
    "data": {
        "paymentId": "sample_paymentId",
        "productRemark": "Invoice payment",
        "requestId": "sample_requestId",
        "userOrderNo": "mo_20260805_001",
        "recipientName": "Alice",
        "recipientAccountId": "acc_recv_001",
        "fiatCurrency": "BRL",
        "fiatAmount": "100.00",
        "cryptoCurrency": "USDT",
        "cryptoAmount": "100.00",
        "quotePrice": "sample_quotePrice",
        "supportCurrency": "USDT",
        "supportNetwork": "ETH",
        "payerInfo": {
            "payerNameUnavailable": true
        },
        "returnUrl": "https://merchant.example/webhook",
        "status": 200,
        "paymentLinkType": "permanent",
        "paymentValidTime": 1,
        "paymentLink": "sample_paymentLink",
        "effectiveTime": 1,
        "expiresTime": 1,
        "createTime": 1720000000000,
        "addressList": [
            {
                "address": "sample_address",
                "addressQrCode": "sample_addressQrCode",
                "coin": "USDT",
                "network": "ETH",
                "name": "Ethereum (ERC20)",
                "memo": "123456789"
            }
        ],
        "amountTolerance": {
            "mode": "NONE",
            "percentage": 0.01,
            "fixedAmount": 0.5
        }
    },
    "traceId": "a1b2c3d4e5f6"
}

Idempotency

Amount tolerance

Deposit addresses

Error codes

Request

Request Code Samples

Responses

Create Payment Link

Idempotency#

Amount tolerance#

Deposit addresses#

Error codes#

Request

Request Code Samples

Responses

Idempotency

Amount tolerance

Deposit addresses

Error codes