Skip to main content
GET
/
v1
/
payout
/
list
cURL
curl --request GET \
  --url https://api.bitnbox.io/v1/payout/list \
  --header 'x-api-key: <api-key>'
{
  "payout": [
    {
      "status": "<string>",
      "amount": 123,
      "merchantAmount": 123,
      "paidAddress": "<string>",
      "orderId": "<string>",
      "customerId": "<string>",
      "payCurrency": {
        "name": "<string>"
      },
      "payNetwork": {
        "name": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "payoutWallet": {
        "label": "<string>",
        "address": "<string>"
      }
    }
  ],
  "count": 123
}

Authorizations

x-api-key
string
header
required

Query Parameters

limit
number | null
required

Limit for pagination

offset
number | null
required

Offset for pagination

Response

200 - application/json

200

Successful response with list of payouts

payout
object[]
required

List of payouts

count
number
required

Total count of payouts