List payouts

GET

payouts

List payouts

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

import requests

url = "https://api.balampay.com/sandbox/v1/payouts"

headers = {
    "Authorization": "Bearer <token>",
    "x-api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.balampay.com/sandbox/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.balampay.com/sandbox/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>",
    "x-api-key: <api-key>"
  ],
]);

$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.balampay.com/sandbox/v1/payouts"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-api-key", "<api-key>")

	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.balampay.com/sandbox/v1/payouts")

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

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

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

{
  "payouts": [
    {
      "payout_id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
      "short_id": "042",
      "user_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "virtual_account_id": "11111111-2222-3333-4444-555555555555",
      "created_at": "2026-09-01T12:00:00.000Z",
      "status": "COMPLETED",
      "origin": "payout",
      "from_amount": "1000.00",
      "from_currency": "USD",
      "to_amount": "986.50",
      "to_currency": "USD",
      "payment_method": "wire",
      "sender_name": "Northwind Trading LLC",
      "recipient_name": "Acme Supplies LLC",
      "reference": "INV-2026-0042",
      "memo": "September invoice",
      "metadata": {}
    }
  ],
  "total": 42,
  "page": 1,
  "limit": 10,
  "total_pages": 5
}

Authorizations

Authorization

string

header

required

The data.access_token value from Get access token.

x-api-key

string

header

required

API key issued by Kira.

Headers

X-Api-Version

string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-04-14"

Query Parameters

page

integer

default:1

Which page to return, counting from 1. This list pages by number, not by offset.

Required range: x >= 1

limit

integer

default:10

How many payouts to return. Between 1 and 100, and 10 when you omit it.

Required range: 1 <= x <= 100

status

string

Filter by payout status.

Available options: CREATED, PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED, IN_REVIEW, KYT_PENDING. See Payout values.

origin

string

Filter by what started the payout.

Available options: deposit, payout, api. See Payout values.

user_id

string<uuid>

Return only the payouts belonging to this user.

recipient_id

string<uuid>

Return only the payouts that went to this recipient.

virtual_account_id

string<uuid>

Return only the payouts that left this account.

from_date

string

Return only payouts created from this moment on. Send a full ISO 8601 timestamp or just a date as YYYY-MM-DD.

to_date

string

Return only payouts created up to this moment. Send a full ISO 8601 timestamp or just a date as YYYY-MM-DD.

string

Free-text search over the payout. Up to 255 characters.

Maximum string length: 255

sort_by

string

Which field to sort on.

Available options: created_at, from_amount, status. created_at when you omit it.

sort_order

string

Which way to sort.

Available options: asc, desc. desc when you omit it.

metadata

object

Return only the payouts carrying the metadata you name, in the ?metadata[key]=value form. Pass more than one key to require all of them.

Each key is 1 to 40 characters and cannot contain [ or ].

Response

Success.

payouts

object[]

Show child attributes

total

integer

Total number of payouts matching the filters.

page

integer

The page returned.

limit

integer

The limit applied to this page.

total_pages

integer

How many pages the filters produce at this limit.

List payouts

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

import requests

url = "https://api.balampay.com/sandbox/v1/payouts"

headers = {
    "Authorization": "Bearer <token>",
    "x-api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.balampay.com/sandbox/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.balampay.com/sandbox/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>",
    "x-api-key: <api-key>"
  ],
]);

$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.balampay.com/sandbox/v1/payouts"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-api-key", "<api-key>")

	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.balampay.com/sandbox/v1/payouts")

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

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

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

{
  "payouts": [
    {
      "payout_id": "99999999-aaaa-bbbb-cccc-dddddddddddd",
      "short_id": "042",
      "user_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "virtual_account_id": "11111111-2222-3333-4444-555555555555",
      "created_at": "2026-09-01T12:00:00.000Z",
      "status": "COMPLETED",
      "origin": "payout",
      "from_amount": "1000.00",
      "from_currency": "USD",
      "to_amount": "986.50",
      "to_currency": "USD",
      "payment_method": "wire",
      "sender_name": "Northwind Trading LLC",
      "recipient_name": "Acme Supplies LLC",
      "reference": "INV-2026-0042",
      "memo": "September invoice",
      "metadata": {}
    }
  ],
  "total": 42,
  "page": 1,
  "limit": 10,
  "total_pages": 5
}

Across the API

Authentication

Versioning

Users

Virtual Accounts

Recipients

Quotations

Payouts

Catalogs

Authorizations

Headers

Query Parameters

Response