GET

/v0/gamertag/transaction/{id}

id*
curl --request GET \
  --url https://api.zebedee.io/v0/gamertag/transaction/{id} \
  --header 'apikey: <apikey>'

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.

Description

In order to get data on payments sent to ZBD Usernames, you can use this endpoint. The data payload returned will inform you of the status of that transaction as well as any associated fees.

Usage

The idea here is to use the transactionId property returned from the Pay to ZBD Username response, and use that ID to fetch the latest details of the given Payment.

Configuration

Path Parameters

idrequired
string

Payment Transaction ID

Header Parameters

apikeyrequired
string

ZBD Project API Key

{
  "message": "Fetched charge.",
  "success": true,
  "data": {
    "id": "903883f2-67d9-4707-a21b-ddff004fe041",
    "receiverId": "ec9b38d5-b126-4307-9d1e-8aa0dfab5d7e",
    "amount": "15000",
    "fee": "1000",
    "unit": "msats",
    "processedAt": "2023-01-04T15:59:16.993Z",
    "confirmedAt": "2023-01-04T15:59:16.989Z",
    "comment": "Sending to ZBD Gamertag",
    "status": "TRANSACTION_STATUS_COMPLETED"
  }
}