Get a payout

curl --request GET \
  --url https://api.spendin.app/v1/payouts/{id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.spendin.app/v1/payouts/{id}', 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.spendin.app/v1/payouts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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.spendin.app/v1/payouts/{id}"

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

	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.spendin.app/v1/payouts/{id}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "id": "a3f1c2d4-...",
  "tenant_id": "<string>",
  "merchant_reference": {},
  "notification_url": {},
  "destination_country": "GH",
  "destination_currency": "GHS",
  "destination_amount": 500,
  "destination_account_unique": "0244000000",
  "destination_provider_name": "MTN",
  "destination_provider_code": "044",
  "destination_account_name": {},
  "settlement_currency": "USDT",
  "settlement_amount": 28.5,
  "exchange_rate": 17.543,
  "platform_fee_amount": 1.5,
  "platform_fee_currency": "USDT",
  "network_fee_amount": 0.5,
  "network_fee_currency": "USDT",
  "total_fee_amount": 2,
  "total_fee_currency": "USDT",
  "is_refunded": false,
  "payment_instruction": {
    "id": "b7e2f1a0-...",
    "rail": "CRYPTO",
    "account_unique": "TXyz1234...abc",
    "provider_name": "USDT (TRC-20)",
    "network": "TRC20",
    "expected_amount": 28.5,
    "expected_currency": "USDT",
    "payment_status": "UNPAID",
    "expires_at": "2026-03-06T15:00:00.000Z",
    "paid_at": "2026-03-06T14:38:14.000Z"
  },
  "status_timeline": [
    {
      "reason_code": "PAYOUT_CREATED",
      "reason_detail": {},
      "metadata": {},
      "created_at": "2026-03-06T14:30:00.000Z"
    }
  ],
  "created_at": "2026-03-06T14:30:00.000Z",
  "updated_at": "2026-03-06T14:30:01.000Z"
}

GET

payouts

{id}

Get a payout

curl --request GET \
  --url https://api.spendin.app/v1/payouts/{id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.spendin.app/v1/payouts/{id}', 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.spendin.app/v1/payouts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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.spendin.app/v1/payouts/{id}"

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

	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.spendin.app/v1/payouts/{id}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "id": "a3f1c2d4-...",
  "tenant_id": "<string>",
  "merchant_reference": {},
  "notification_url": {},
  "destination_country": "GH",
  "destination_currency": "GHS",
  "destination_amount": 500,
  "destination_account_unique": "0244000000",
  "destination_provider_name": "MTN",
  "destination_provider_code": "044",
  "destination_account_name": {},
  "settlement_currency": "USDT",
  "settlement_amount": 28.5,
  "exchange_rate": 17.543,
  "platform_fee_amount": 1.5,
  "platform_fee_currency": "USDT",
  "network_fee_amount": 0.5,
  "network_fee_currency": "USDT",
  "total_fee_amount": 2,
  "total_fee_currency": "USDT",
  "is_refunded": false,
  "payment_instruction": {
    "id": "b7e2f1a0-...",
    "rail": "CRYPTO",
    "account_unique": "TXyz1234...abc",
    "provider_name": "USDT (TRC-20)",
    "network": "TRC20",
    "expected_amount": 28.5,
    "expected_currency": "USDT",
    "payment_status": "UNPAID",
    "expires_at": "2026-03-06T15:00:00.000Z",
    "paid_at": "2026-03-06T14:38:14.000Z"
  },
  "status_timeline": [
    {
      "reason_code": "PAYOUT_CREATED",
      "reason_detail": {},
      "metadata": {},
      "created_at": "2026-03-06T14:30:00.000Z"
    }
  ],
  "created_at": "2026-03-06T14:30:00.000Z",
  "updated_at": "2026-03-06T14:30:01.000Z"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

string<uuid>

required

Response

Payout found

string

required

Example:

"a3f1c2d4-..."

tenant_id

string

required

status

enum<string>

required

Available options:

CREATED,

PENDING_PAYMENT,

PAYMENT_RECEIVED,

PROCESSING,

SUCCESSFUL,

FAILED,

EXPIRED

merchant_reference

object | null

required

notification_url

object | null

required

Per-payout webhook override, if set

destination_type

enum<string>

required

Available options:

MOBILE_MONEY,

BANK_ACCOUNT,

CRYPTO_WALLET

destination_country

string

required

Example:

"GH"

destination_currency

string

required

Example:

"GHS"

destination_amount

number

required

Example:

500

destination_account_unique

string

required

Example:

"0244000000"

destination_provider_name

string

required

Example:

"MTN"

destination_provider_code

object | null

required

Bank code / mobile money code the processor routes on. Null for crypto.

Example:

"044"

destination_account_name

object | null

required

settlement_currency

string

required

Example:

"USDT"

settlement_amount

number

required

Set by generate-payment-instructions job

Example:

28.5

exchange_rate

number

required

Example:

17.543

platform_fee_amount

number

required

Example:

1.5

platform_fee_currency

string

required

Example:

"USDT"

network_fee_amount

number

required

Example:

0.5

network_fee_currency

string

required

Example:

"USDT"

total_fee_amount

number

required

Example:

2

total_fee_currency

string

required

Example:

"USDT"

is_refunded

boolean

required

Example:

false

payment_instruction

object | null

required

Current active payment instruction, if generated (null until the cronjob runs)

Show child attributes

status_timeline

object[]

required

Status transition history, oldest → newest

Show child attributes

created_at

string

required

Example:

"2026-03-06T14:30:00.000Z"

updated_at

string

required

Example:

"2026-03-06T14:30:01.000Z"

⌘I

Overview

Endpoints

Get a payout

Authorizations

Path Parameters

Response