List Payment links

Filter precedence

The filters are not all combined. Exactly one of three branches runs, in this order.

Branch	Applies when	What filters
1	`paymentId` supplied	`paymentId` alone
2	no `paymentId`, `requestId` supplied	`requestId` alone
3	neither supplied	every other filter, combined with AND

paymentId wins outright. Every other filter is dropped, referencePaymentId included.

requestId comes next. With paymentId absent and requestId present, every remaining
filter is dropped, referencePaymentId included. A blank requestId falls back to
userOrderNo — both match the same stored value, so they are not two independent filters.
Only primary Payment Links carry this value, so this branch never returns a child record.

Otherwise the remaining filters combine with AND: recipientAccountId, fiatCurrency,
cryptoCurrency, supportCurrency, supportNetwork, paymentLinkType, statuses, the
startTime / endTime range, and either referencePaymentId or primaryOrderOnly. Supplying
referencePaymentId pages that parent's child records and makes primaryOrderOnly irrelevant;
without it, primaryOrderOnly defaults to true and limits the result to primary links.

Branch 3 returns newest first. Branches 1 and 2 match at most one record.

Query by merchant request ID

Use requestId for an exact merchant request ID filter.

Primary payment links

primaryOrderOnly defaults to true and returns only primary Payment Links. Set it to false to include
primary links and actual payment child records. It is ignored when referencePaymentId, paymentId or requestId is supplied.

Permanent child payments

referencePaymentId is optional; use a permanent parent Payment ID to page its actual payment records.

referencePaymentId is ignored when paymentId or requestId is supplied — see Filter precedence.

A child record returns referencePaymentId to identify its parent permanent Payment Link.

Status and completion

processing means the payment is confirmed and merchant funds are still being processed. Treat a payment
as complete only when its status becomes completed.

Amount tolerance

Each record reports the tolerance in effect for it in amountTolerance. mode NONE means the payment
had to match the expected amount exactly. Only One-Time links can carry a tolerance; see
POST /v1/stable/collect/create-payment-link for how the band is applied. Records for Payment Links
created before this release omit the field entirely — treat an absent amountTolerance as exact-amount
matching.

Deposit addresses

addressList is returned only for links whose deposit addresses were pre-allocated at creation, which
depends on merchant configuration. Every other record omits it, and the payer obtains the address
through the hosted checkout link.

Request

Authorization

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: ********************

Body Params application/jsonRequired

Example

{
    "pageNum": 1,
    "pageSize": 20,
    "paymentId": "sample_paymentId",
    "referencePaymentId": "sample_parentPaymentId",
    "requestId": "sample_requestId",
    "userOrderNo": "mo_20260805_001",
    "recipientAccountId": "acc_recv_001",
    "fiatCurrency": "BRL",
    "cryptoCurrency": "USDT",
    "supportCurrency": "USDT",
    "supportNetwork": "ETH",
    "paymentLinkType": "permanent",
    "statuses": [],
    "primaryOrderOnly": true,
    "startTime": 1,
    "endTime": 1
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "status": 200,
    "code": "SUCCESS",
    "msg": "ok",
    "data": {
        "pageNumber": 1,
        "pageSize": 20,
        "totalPage": 1,
        "totalRow": 1,
        "records": []
    },
    "traceId": "a1b2c3d4e5f6"
}

Filter precedence#

Query by merchant request ID#

Primary payment links#

Permanent child payments#

Status and completion#

Amount tolerance#

Deposit addresses#

Request

Request Code Samples

Responses

Filter precedence

Query by merchant request ID

Primary payment links

Permanent child payments

Status and completion

Amount tolerance

Deposit addresses