List payouts

GET

payouts

List payouts

curl --request GET \
  --url https://api.example.com/v1/payouts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/payouts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/payouts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "hasMore": true,
  "payouts": [
    {
      "amount": "100.50",
      "beneficiary": {
        "accounts": [
          {
            "createdAt": "2024-01-15T10:30:00Z",
            "currency": "EUR",
            "data": {
              "bic": "DEUTDEFF",
              "iban": "DE89370400440532013000"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "status": "active",
            "type": "iban",
            "updatedAt": "2024-01-15T10:35:00Z"
          }
        ],
        "createdAt": "2024-01-15T10:30:00Z",
        "email": "john.doe@example.com",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "John Doe",
        "status": "active",
        "updatedAt": "2024-01-15T10:35:00Z"
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "currency": "EUR",
      "fee": "2.50",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "route": "international",
      "status": "processing",
      "type": "fiat",
      "updatedAt": "2024-01-15T10:35:00Z",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "balanceAfter": "98.87",
      "clientRef": "PAYOUT-REF-12345",
      "completedAt": "2024-01-15T10:40:00Z",
      "description": "Payment for services rendered",
      "failureCategory": "payment_not_approved",
      "failureReason": "Insufficient funds",
      "fxRate": "970.87378641",
      "inputAmount": "1.13",
      "inputCurrency": "EUR",
      "payoutAccountData": {
        "account": 123456789,
        "bankCode": "044",
        "crAccount": "0123456789"
      },
      "payoutAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "processedAt": "2024-01-15T10:32:00Z",
      "providerReference": "TXN123456789",
      "reference": "January invoice",
      "txHash": "0x3a1f9c2b4d5e6f70819a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f70",
      "uetr": "4afd0a57-03af-4138-9341-373a78891ea9"
    }
  ],
  "nextCursor": "2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "total": 1247
}

Authorizations

Authorization

string

header

required

Enter Auth0 JWT token

Headers

Zuba-Account-Id

string<uuid>

Optional. Names an owned sub-account (UUID) to act on. Omit to act at the master (tenant) level. Naming an account this key does not own returns 403 not_account_owner.

Query Parameters

beneficiaryId

string<uuid>

Filter by beneficiary ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

clientRef

string

Return the payout created with this client reference (exact match). References are unique per workspace, so at most one payout matches; an empty list means no payout was ever created with this reference.

Maximum string length: 100

Example:

"1000000026117856401"

status

string

Filter by status (comma-separated)

Example:

"processing,paid"

country

string

Filter by country code (comma-separated)

Example:

"DE,GB"

route

string

Filter by payment route (comma-separated)

Example:

"sepa_inst,sepa_credit"

provider

string

Filter by account holder name

Example:

"Acme Ltd"

startDate

string<date-time>

Start date for date range filter (ISO 8601)

Example:

"2024-01-01T00:00:00Z"

endDate

string<date-time>

End date for date range filter (ISO 8601)

Example:

"2024-12-31T23:59:59Z"

minAmount

string

Minimum amount filter (decimal string; the legacy numeric form is also accepted)

Example:

"100"

maxAmount

string

Maximum amount filter (decimal string; the legacy numeric form is also accepted)

Example:

"1000"

string

Free-text search across payout ID, client reference, reference, beneficiary name, and bank/account details

Maximum string length: 100

Example:

"Chinedu Ibe"

cursor

string

Cursor for pagination (composite: timestamp__uuid)

Example:

"2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890"

limit

number

default:20

Number of items per page

Required range: 1 <= x <= 100

Example:

20

Response

List of payouts

hasMore

boolean

required

Whether there are more payouts to load

Example:

true

payouts

object[]

required

List of payouts

Show child attributes

nextCursor

string

Next cursor for pagination (composite: timestamp__uuid)

Example:

"2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890"

total

number

Total number of payouts matching the query, ignoring pagination. Returned on the first page only (omitted on cursor pages).

Example:

1247

List payouts

curl --request GET \
  --url https://api.example.com/v1/payouts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/payouts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/payouts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "hasMore": true,
  "payouts": [
    {
      "amount": "100.50",
      "beneficiary": {
        "accounts": [
          {
            "createdAt": "2024-01-15T10:30:00Z",
            "currency": "EUR",
            "data": {
              "bic": "DEUTDEFF",
              "iban": "DE89370400440532013000"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "status": "active",
            "type": "iban",
            "updatedAt": "2024-01-15T10:35:00Z"
          }
        ],
        "createdAt": "2024-01-15T10:30:00Z",
        "email": "john.doe@example.com",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "John Doe",
        "status": "active",
        "updatedAt": "2024-01-15T10:35:00Z"
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "currency": "EUR",
      "fee": "2.50",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "route": "international",
      "status": "processing",
      "type": "fiat",
      "updatedAt": "2024-01-15T10:35:00Z",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "balanceAfter": "98.87",
      "clientRef": "PAYOUT-REF-12345",
      "completedAt": "2024-01-15T10:40:00Z",
      "description": "Payment for services rendered",
      "failureCategory": "payment_not_approved",
      "failureReason": "Insufficient funds",
      "fxRate": "970.87378641",
      "inputAmount": "1.13",
      "inputCurrency": "EUR",
      "payoutAccountData": {
        "account": 123456789,
        "bankCode": "044",
        "crAccount": "0123456789"
      },
      "payoutAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "processedAt": "2024-01-15T10:32:00Z",
      "providerReference": "TXN123456789",
      "reference": "January invoice",
      "txHash": "0x3a1f9c2b4d5e6f70819a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f70",
      "uetr": "4afd0a57-03af-4138-9341-373a78891ea9"
    }
  ],
  "nextCursor": "2024-01-15T10:30:00.000Z__a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "total": 1247
}