POST

/v0/gamertag/send-payment

apikey*
Content-Type
curl --request POST \
  --url https://sandbox-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.

This API endpoint is to be used with the ZBD Sandbox API. To use this API you must first create a Project in the ZBD Dev Dashboard and then generate a Sandbox API Key.

Sandbox keys only work with the Sandbox API. Live keys only work with the Live API.

Description

This API endpoint is used to send fake Sandbox Bitcoin payments directly to a user’s ZBD Gamertag.

Usage

The idea behind this API endpoint is to allow developers integrating ZBD Gamertag capabilities to test their integrations before going Live.

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 SANDBOX ZBD Username

description
string

Note or comment for this Payment (visible to recipient)

{
  "success": true,
  "data": {
    "id": "4a67ea26-00b7-4310-82bd-2c5d1490cc2a",
    "status": "settled",
    "transactionId": "4be87b3a-bf40-45fa-9624-1aa5cb6d61c5",
    "receiverId": "14db5692-133a-42ba-a58d-abbcae282185",
    "amount": "1000",
    "comment": "Sending to Gamertag",
    "settledAt": "2023-04-13T15:38:54.595Z"
  },
  "message": "Payment done.",
}