API ReferenceMerchant API
Create a new payout.
Initiates a withdrawal to the specified destination address. The
payout enters pending_approval status and must be approved via
the dashboard before execution.
X-API-Key<token>
API key issued by the merchant dashboard. The key's environment (live/test) determines which data the caller can access. Permissions on the key control which endpoints are reachable.
In: header
currencystring
Cryptocurrency code.
Length
length <= 20amountstring
Decimal string amount to send.
Length
length <= 50destinationstring
Destination blockchain address.
Length
length <= 256destination_tag?string
Memo/tag for chains that require it.
Length
length <= 256description?string
Human-readable payout description.
Length
length <= 1000metadata?object
Key-value metadata.
Properties
properties <= 50Empty Object
idempotency_key?string
Idempotency key to prevent duplicate payouts.
Length
length <= 255Response Body
const body = JSON.stringify({ "currency": "string", "amount": "string", "destination": "string"})fetch("https://api.halfin.xyz/api/v1/payouts", { method: "POST", headers: { "Content-Type": "application/json" }, body}){
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"currency": "string",
"network": "string",
"amount": "string",
"amount_in_base_currency": "string",
"network_fee": "string",
"fee_amount": "string",
"destination": "string",
"destination_tag": "string",
"status": "pending_approval",
"environment": "live",
"tx_hash": "string",
"idempotency_key": "string",
"description": "string",
"executable_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"meta": {
"request_id": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
]
},
"meta": {
"request_id": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
]
},
"meta": {
"request_id": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
]
},
"meta": {
"request_id": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
]
},
"meta": {
"request_id": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
]
},
"meta": {
"request_id": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
]
},
"meta": {
"request_id": "string"
}
}