POST
/
nps
/
withdraw
cURL
curl --request POST \
  --url https://apidev.nusd.me/nps/withdraw \
  --header 'BIZ-API-KEY: <api-key>' \
  --header 'Biz-Api-Nonce: <api-key>' \
  --header 'Biz-Api-Signature: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "request_id": "d8551182-0aee-4346-929e-05c99081352a",
  "wallet_id": "e9167870-e18b-4e82-8b87-92ec7ede8e45",
  "to": "0xdc2e6b357766aa4b66f41dc29598379ce7d61d46",
  "amount": "10.08",
  "chain_id": "BASE_ETH",
  "token_id": "BASE_USDT"
}
'
{
  "status": 0,
  "data": {
    "transaction_id": "28f2505c-55ab-4fc7-8620-152c4045981a",
    "request_id": "9bfa5014-2f12-4eb8-b979-3cf8cb947b45"
  },
  "msg": "<string>"
}

Authorizations

​
BIZ-API-KEY
string
header
required

API key. Must be included in the request header.

​
Biz-Api-Nonce
string
header
required

Timestamp. Must be included in the request header.

​
Biz-Api-Signature
string
header
required

Signature string. Must be included in the request header.

Body

application/json
​
request_id
string
required

Requester ID. Must be unique.

Example:

"d8551182-0aee-4346-929e-05c99081352a"

​
wallet_id
string
required

Wallet ID to withdraw from.

Example:

"e9167870-e18b-4e82-8b87-92ec7ede8e45"

​
to
string
required

Withdrawal destination address.

Example:

"0xdc2e6b357766aa4b66f41dc29598379ce7d61d46"

​
amount
number<float>
required

Withdrawal amount.

Example:

"10.08"

​
chain_id
string
required

Chain ID.

Example:

"BASE_ETH"

​
token_id
string
required

Unique identifier of the token.

Example:

"BASE_USDT"

​
payer
string

Party paying the fee. Defaults to the user.

  • App: Paid by the platform
  • User: Paid by the user
Example:

"App"

Response

Request succeeded. Returns the withdrawal transaction ID.

​
status
integer

Status code. 0 indicates success.

Example:

0

​
data
object

Withdrawal details.

​
msg
string

Error message. Present when status is non-zero.