Skip to main content
POST
Refund held deposit

Authorizations

Authorization
string
header
required

Your API key from Console → Settings → Key & Access, sent as Authorization: Bearer ncl_....

Body

application/x-www-form-urlencoded
transfer_id
string
required

Transfer ID, the transfer_id from the deposit webhook

Example:

"78ef8cb6-bdd1-4f79-b1a1-62489a8d4e9466333"

address
string
required

Refund address (double-check it; funds sent to a wrong address are lost)

Example:

"TEKUmbfUeMmicz7V11rY3nx6ijmsmZk9MJ"

Response

200 - application/json

Success

code
integer
required
msg
string
required
data
string
required

Refund number