Generate Payout

This endpoint enables you to generate a cryptocurrency payout request, allowing you to transfer funds to a specified address. It is designed to facilitate seamless and secure transactions by generating a payout request within your account.

post

Header parameters

payout_api_keystringRequired

Your Payout API Key for authentication and authorization.

Content-TypestringRequiredDefault: application/json

Body

application/json

addressstringRequired

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

currencystringRequired

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

amountnumber · decimalRequired

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

networkstringOptional

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

callback_urlstring · uriOptional

The URL for sending payment status updates.

memostringOptional

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

descriptionstringOptional

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

Responses

200

Successful operation

application/json

messagestringOptional

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

statusintegerOptional

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

versionstringOptional

The version of the API being used.

400

Bad request

application/json

post

/payout

PythoncURLPHPNode.js

import requests
import json

url = 'https://api.oxapay.com/v1/payout'

data = {
    "address": "RECEIVER_ADDRESS",
    "amount": 5,
    "currency": "TRX",
    "network": "TRC20",
    "callback_url": "https://example.com/callback",
    "memo": "Memo12345",
    "description": "Order #12345"
}

headers = {
    'payout_api_key': 'YOUR_PAYOUT_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.post(url, data=json.dumps(data), headers=headers)
result = response.json()
print(result)

{
  "data": {
    "track_id": "258298451",
    "status": "processing"
  },
  "message": "Operation completed successfully!",
  "error": {},
  "status": 200,
  "version": "1.0.0"
}