Withdrawal Requests

Create Withdrawal Request

Start creating Bitcoin voucher QR codes.

post/v0/withdrawal-requests

Request

The document declares no server URL.
Auth
API key in header apikey
TypeScript
https://skmtc.dev/zbdpay/apis/zbd-payments-api/docs/v0/withdrawal-requests/post.ts
A function with typed inputs. Its response is checked against the schema.

Content-Typestring

Content Type

amountstring

The amount for the Withdrawal Request -> in millisatoshis

descriptionstring

Note or comment for this Withdrawal Request

expiresInnumber

Time until Withdrawal Request expiration -> in seconds

internalIdstring

Open metadata string property

callbackUrlstring

The endpoint ZBD will POST Charge updates to

Successful response

Apr 18, 2025b749c336df59 Revision changes
- warning
  deleted the header request parameter apikey
- info
  the endpoint scheme security apikeyAuth was added to the API
Apr 18, 2025028610bc46ff Revision changes
- breaking
  the header request parameter apikey became required