ZBD User
Pay to ZBD Username
Send instant Bitcoin payments to ZBD Users.
POST
/v0/gamertag/send-payment
apikey*
Content-Type
curl --request POST \
--url https://api.zebedee.io/v0/gamertag/send-payment \
--header 'Content-Type: application/json' \
--header 'apikey: <apikey>' \
--data '{
"amount": "<amount>",
"gamertag": "<gamertag>",
"description": ""
}'
ZBD API is migrating the terminology from ZBD Gamertags to ZBD Usernames. There are no breaking changes to you as a developer.
In general, if you used to search for ‘Gamertag’ inside zbd.dev documentation, now search for ‘Username’. Please do also note some ZBD API endpoints are still using gamertag
in the URL.
Unlike other payout endpoints in the ZBD API, sending payments to ZBD Usernames is a synchronous action -> this is why there is no
callbackUrl
property. The payment either succeeds or fails on the spot.Configuration
Header Parameters
apikeyrequired
string
ZBD Project API Key
Content-Type
string
Content Type
Body
amountrequired
string
The amount for the Payment -> in millisatoshis
gamertagrequired
string
Destination ZBD Gamertag
description
string
Note or comment for this Payment (visible to recipient)
{
"success": true,
"data": {
"id": "49cccd62-b686-4057-9f44-f492bd54ac39",
"status": "settled",
"transactionId": "78fb6474-d791-47a1-bda1-a4b9023898c0",
"receiverId": "ec9b38d5-b126-4307-9d1e-8aa0dfab5d7e",
"amount": "1000",
"comment": "Sent to ZBD Gamertag",
"settledAt": "2023-07-19T21:42:54.993Z"
},
"message": "Payment done."
}
Was this page helpful?
curl --request POST \
--url https://api.zebedee.io/v0/gamertag/send-payment \
--header 'Content-Type: application/json' \
--header 'apikey: <apikey>' \
--data '{
"amount": "<amount>",
"gamertag": "<gamertag>",
"description": ""
}'
{
"success": true,
"data": {
"id": "49cccd62-b686-4057-9f44-f492bd54ac39",
"status": "settled",
"transactionId": "78fb6474-d791-47a1-bda1-a4b9023898c0",
"receiverId": "ec9b38d5-b126-4307-9d1e-8aa0dfab5d7e",
"amount": "1000",
"comment": "Sent to ZBD Gamertag",
"settledAt": "2023-07-19T21:42:54.993Z"
},
"message": "Payment done."
}