Prepay Whitelist for One-Time Payment Link

Prepay whitelist for a One-Time payment link

POST /v1/stable/collect/payment-links/onetime/prepay-whitelist

Call it after POST /v1/stable/collect/create-payment-link. orderId is the paymentId from that response. walletId must equal that link's recipientAccountId.

Why whitelist

Crypto paid through this payment link is usable only after the payer details pass the deposit whitelist.

If you skip this call

The on-chain payment is still received, but it stays gated:

The order moves to pending_whitelist.

The funds sit in the unavailable balance of the receiving wallet. They cannot be withdrawn or converted.

If the payer has paid and the source address is not whitelisted yet, PAYMENT_LINK_UPDATED is sent with data.status pending_whitelist. After the whitelist is approved and the funds are credited, the existing completion webhook is sent with data.status completed.

Submit payer details after the payment arrives

Use this when the order is pending_whitelist, or a previous submission was rejected.

Call POST /v1/wallet/deposit-whitelist/transactions/{transactionId}/submit with the payer details. transactionId is the paymentId on that PAYMENT_LINK_UPDATED. Do not send the source address, network, memo, or transaction hash. Those come from the on-chain payment.

On rejection, read failMessage and submit again. The funds stay unavailable.

When the whitelist is approved and the funds are credited, PAYMENT_LINK_UPDATED is sent with data.status completed.

Guide: Wallet · Deposit whitelist

Which call

Link type	Endpoint	When
`onetime`	`POST /v1/stable/collect/payment-links/onetime/prepay-whitelist`	After `POST /v1/stable/collect/create-payment-link`
`permanent`	`POST /v1/stable/collect/payment-links/permanent/prepay-whitelist`	After the hosted payment page has called `create-permanent-prepay`

Use the endpoint that matches the link's paymentLinkType. A mismatch returns ODR00000041.

This call covers this payment link only. To reuse one payer for every deposit into a sub-wallet, use POST /v1/wallet/deposit-whitelist/wallets/{walletId}/profile.

travelRule uses the same payer fields as Address Book / submit:

`correspondentType`	Required inside `travelRule`
`ENTITY`	`fullName`, `countryCode`, `companyAddress`
`INDIVIDUAL`	`firstName`, `lastName`, `birthday` (`yyyy-MM-dd`), `countryCode`, `residentialAddress`

Do not send walletAddress, network, memo, symbol, or txHash inside travelRule. Do not send countryInfo.

Authentication is the same as the other Stable collect APIs.

Failures

Business failure uses status 500.

`code`	When
`ODR00000041`	`paymentLinkType` is not `onetime`; `walletId` is not the link's recipient account; the order is not owned by the caller; `walletId` or `travelRule` is missing
`10000103`	A `travelRule` value is not accepted. An unrecognised `countryCode` returns this code.

Example

{
  "orderId": "PAY2025101507677652572380042240",
  "walletId": 10086,
  "travelRule": {
    "walletLabel": "Payport Limited",
    "addressType": "STANDARD",
    "walletType": "VASP",
    "provider": "Binance",
    "correspondentType": "ENTITY",
    "fullName": "Payport Limited",
    "countryCode": "SG",
    "companyAddress": "Tampines Blk67, Singapore"
  }
}

Success data:

{
  "prepayId": null,
  "bizNo": "PAY2025101507677652572380042240",
  "saved": true
}

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

Header Params

Body Params application/jsonRequired

Example

{
  "orderId": "PAY2025101507677652572380042240",
  "walletId": 10086,
  "travelRule": {
    "walletLabel": "Payport Limited",
    "addressType": "STANDARD",
    "walletType": "VASP",
    "provider": "Binance",
    "correspondentType": "ENTITY",
    "fullName": "Payport Limited",
    "countryCode": "SG",
    "companyAddress": "Tampines Blk67, Singapore"
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

{ "status": 200, "msg": "OK", "code": null, "traceId": "a1b2c3d4e5f6", "data": { "prepayId": null, "bizNo": "PAY2025101507677652572380042240", "saved": true } }

Prepay Whitelist for One-Time Payment Link

Prepay whitelist for a One-Time payment link#

Why whitelist#

If you skip this call#

Submit payer details after the payment arrives#

Which call#

Failures#

Example#

Request

Request Code Samples

Responses

Prepay whitelist for a One-Time payment link

Why whitelist

If you skip this call

Submit payer details after the payment arrives

Which call

Failures

Example