v1

latestOpenAPI 3.0.02026-07-2323080.8 KB
Generate-payout

post/payout

Headers

payout_api_keystring required

Your Payout API Key for authentication and authorization.

Content-Typestring required

Request body

addressstring required

The recipient's cryptocurrency address where the payout will be sent.

currencystring required

The symbol of the cryptocurrency to be sent (e.g., BTC, ETH, LTC, etc.).

amountnumber required

The exact amount of cryptocurrency to be sent as the payout.

networkstring

The blockchain network to be used for the payout. Required for currencies with multiple supported networks.

callback_urlstring uri

The URL for sending payment status updates.

memostring

A memo or tag for transactions on supported networks (e.g., for GRAM).

descriptionstring

A description or additional information for the payout, useful for reports.

Response

Successful operation

messagestring

A message containing additional information about the result of the request.

statusinteger

The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors).

versionstring

The version of the API being used.