POST
/
nps
/
transfer
cURL
curl --request POST \
  --url https://apidev.nusd.me/nps/transfer \
  --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": "ea6f928b-0b1f-4fd3-a4fe-fc10695d2642",
  "wallet_from": "332cf3e4-af07-46f9-a3da-4aa2cbe3bdd4",
  "wallet_to": "1b8d5efd-d7a8-48ac-a195-cc8e043ae36b",
  "amount": 0.003
}
'
{
  "status": 0,
  "data": {
    "request_id": "9bfa5014-2f12-4eb8-b979-3cf8cb947b45",
    "transaction_id": "28f2505c-55ab-4fc7-8620-152c4045981a"
  },
  "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

Unique request ID from the caller.

Example:

"ea6f928b-0b1f-4fd3-a4fe-fc10695d2642"

wallet_from
string
required

Source wallet ID.

Example:

"332cf3e4-af07-46f9-a3da-4aa2cbe3bdd4"

wallet_to
string
required

Destination wallet ID.

Example:

"1b8d5efd-d7a8-48ac-a195-cc8e043ae36b"

amount
number<float>
required

Transfer amount.

Example:

0.003

user_token
string

Recipient's unique user ID or token within the app (optional).

Example:

"10001"

user_name
string

Recipient's name or nickname (optional).

Example:

""

notes
string

Remarks (optional).

Example:

""

Response

Request succeeded. Returns transfer transaction ID.

status
integer

Status code. 0 indicates success.

Example:

0

data
object

Transfer result.

msg
string

Error message. Present when status is non-zero.