ZBD Gamertag
Create Charge
ZBD Gamertag
Create Charge
Generate a payment request for a ZBD User.
POST
/
v0
/
gamertag
/
charges
Description
While you can use the Pay to ZBD Gamertag endpoint to make a direct Bitcoin payment to a given ZBD user, if for whatever reason you’d want to create a general Lightning Network Charge / Payment Request QR code, you can use this endpoint.
The response payload will include a
invoiceRequest which is the contents of the Charge / Payment Request QR code. Do note that Charges have defined expiration times. After a Charge expires it cannot be paid, simply create another Charge.Configuration
Header Parameters
apikey
string
requiredZBD Project API Key
Content-Type
string
Content Type
Body
amount
string
requiredThe amount for the Payment -> in millisatoshis
gamertag
string
requiredDestination ZBD Gamertag
description
string
Note or comment for this Payment (visible to recipient)
expiresIn
number
Time until Charge expiration -> in seconds
internalId
string
Open metadata string property
callbackUrl
string
The endpoint ZBD will POST Charge updates to
Was this page helpful?