API ReferenceMerchant API
Create a permanent static deposit address.
Creates a new static deposit address for the specified currency. Deposits to this address auto-create invoices.
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 for the static address.
Length
length <= 20label?string
Optional human-readable label.
Length
length <= 1000Response Body
const body = JSON.stringify({ "currency": "string"})fetch("https://api.halfin.xyz/api/v1/addresses", { method: "POST", headers: { "Content-Type": "application/json" }, body}){
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
"currency": "string",
"environment": "live",
"gate_id": "string",
"address": "string",
"address_tag": "string",
"label": "string",
"total_received": "string",
"invoice_count": 0,
"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"
}
}