Create a payout request

curl --request POST \
  --url https://api.spendin.app/v1/payouts \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "destination_type": "MOBILE_MONEY",
  "destination_country": "GH",
  "destination_currency": "GHS",
  "destination_amount": 500,
  "destination_account_unique": "0244000000",
  "destination_provider_name": "MTN",
  "settlement_currency": "USDT",
  "settlement_network": "TRON",
  "destination_provider_code": "044",
  "destination_account_name": "Kwame Mensah",
  "merchant_reference": "ref_merchant_xyz_001",
  "notification_url": "https://merchant.example.com/hooks/this-payout"
}
'

import requests

url = "https://api.spendin.app/v1/payouts"

payload = {
    "destination_type": "MOBILE_MONEY",
    "destination_country": "GH",
    "destination_currency": "GHS",
    "destination_amount": 500,
    "destination_account_unique": "0244000000",
    "destination_provider_name": "MTN",
    "settlement_currency": "USDT",
    "settlement_network": "TRON",
    "destination_provider_code": "044",
    "destination_account_name": "Kwame Mensah",
    "merchant_reference": "ref_merchant_xyz_001",
    "notification_url": "https://merchant.example.com/hooks/this-payout"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    destination_type: 'MOBILE_MONEY',
    destination_country: 'GH',
    destination_currency: 'GHS',
    destination_amount: 500,
    destination_account_unique: '0244000000',
    destination_provider_name: 'MTN',
    settlement_currency: 'USDT',
    settlement_network: 'TRON',
    destination_provider_code: '044',
    destination_account_name: 'Kwame Mensah',
    merchant_reference: 'ref_merchant_xyz_001',
    notification_url: 'https://merchant.example.com/hooks/this-payout'
  })
};

fetch('https://api.spendin.app/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.spendin.app/v1/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'destination_type' => 'MOBILE_MONEY',
    'destination_country' => 'GH',
    'destination_currency' => 'GHS',
    'destination_amount' => 500,
    'destination_account_unique' => '0244000000',
    'destination_provider_name' => 'MTN',
    'settlement_currency' => 'USDT',
    'settlement_network' => 'TRON',
    'destination_provider_code' => '044',
    'destination_account_name' => 'Kwame Mensah',
    'merchant_reference' => 'ref_merchant_xyz_001',
    'notification_url' => 'https://merchant.example.com/hooks/this-payout'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spendin.app/v1/payouts"

	payload := strings.NewReader("{\n  \"destination_type\": \"MOBILE_MONEY\",\n  \"destination_country\": \"GH\",\n  \"destination_currency\": \"GHS\",\n  \"destination_amount\": 500,\n  \"destination_account_unique\": \"0244000000\",\n  \"destination_provider_name\": \"MTN\",\n  \"settlement_currency\": \"USDT\",\n  \"settlement_network\": \"TRON\",\n  \"destination_provider_code\": \"044\",\n  \"destination_account_name\": \"Kwame Mensah\",\n  \"merchant_reference\": \"ref_merchant_xyz_001\",\n  \"notification_url\": \"https://merchant.example.com/hooks/this-payout\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.spendin.app/v1/payouts")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destination_type\": \"MOBILE_MONEY\",\n  \"destination_country\": \"GH\",\n  \"destination_currency\": \"GHS\",\n  \"destination_amount\": 500,\n  \"destination_account_unique\": \"0244000000\",\n  \"destination_provider_name\": \"MTN\",\n  \"settlement_currency\": \"USDT\",\n  \"settlement_network\": \"TRON\",\n  \"destination_provider_code\": \"044\",\n  \"destination_account_name\": \"Kwame Mensah\",\n  \"merchant_reference\": \"ref_merchant_xyz_001\",\n  \"notification_url\": \"https://merchant.example.com/hooks/this-payout\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spendin.app/v1/payouts")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"destination_type\": \"MOBILE_MONEY\",\n  \"destination_country\": \"GH\",\n  \"destination_currency\": \"GHS\",\n  \"destination_amount\": 500,\n  \"destination_account_unique\": \"0244000000\",\n  \"destination_provider_name\": \"MTN\",\n  \"settlement_currency\": \"USDT\",\n  \"settlement_network\": \"TRON\",\n  \"destination_provider_code\": \"044\",\n  \"destination_account_name\": \"Kwame Mensah\",\n  \"merchant_reference\": \"ref_merchant_xyz_001\",\n  \"notification_url\": \"https://merchant.example.com/hooks/this-payout\"\n}"

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"
}

POST

payouts

Create a payout request

curl --request POST \
  --url https://api.spendin.app/v1/payouts \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "destination_type": "MOBILE_MONEY",
  "destination_country": "GH",
  "destination_currency": "GHS",
  "destination_amount": 500,
  "destination_account_unique": "0244000000",
  "destination_provider_name": "MTN",
  "settlement_currency": "USDT",
  "settlement_network": "TRON",
  "destination_provider_code": "044",
  "destination_account_name": "Kwame Mensah",
  "merchant_reference": "ref_merchant_xyz_001",
  "notification_url": "https://merchant.example.com/hooks/this-payout"
}
'

import requests

url = "https://api.spendin.app/v1/payouts"

payload = {
    "destination_type": "MOBILE_MONEY",
    "destination_country": "GH",
    "destination_currency": "GHS",
    "destination_amount": 500,
    "destination_account_unique": "0244000000",
    "destination_provider_name": "MTN",
    "settlement_currency": "USDT",
    "settlement_network": "TRON",
    "destination_provider_code": "044",
    "destination_account_name": "Kwame Mensah",
    "merchant_reference": "ref_merchant_xyz_001",
    "notification_url": "https://merchant.example.com/hooks/this-payout"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    destination_type: 'MOBILE_MONEY',
    destination_country: 'GH',
    destination_currency: 'GHS',
    destination_amount: 500,
    destination_account_unique: '0244000000',
    destination_provider_name: 'MTN',
    settlement_currency: 'USDT',
    settlement_network: 'TRON',
    destination_provider_code: '044',
    destination_account_name: 'Kwame Mensah',
    merchant_reference: 'ref_merchant_xyz_001',
    notification_url: 'https://merchant.example.com/hooks/this-payout'
  })
};

fetch('https://api.spendin.app/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.spendin.app/v1/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'destination_type' => 'MOBILE_MONEY',
    'destination_country' => 'GH',
    'destination_currency' => 'GHS',
    'destination_amount' => 500,
    'destination_account_unique' => '0244000000',
    'destination_provider_name' => 'MTN',
    'settlement_currency' => 'USDT',
    'settlement_network' => 'TRON',
    'destination_provider_code' => '044',
    'destination_account_name' => 'Kwame Mensah',
    'merchant_reference' => 'ref_merchant_xyz_001',
    'notification_url' => 'https://merchant.example.com/hooks/this-payout'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spendin.app/v1/payouts"

	payload := strings.NewReader("{\n  \"destination_type\": \"MOBILE_MONEY\",\n  \"destination_country\": \"GH\",\n  \"destination_currency\": \"GHS\",\n  \"destination_amount\": 500,\n  \"destination_account_unique\": \"0244000000\",\n  \"destination_provider_name\": \"MTN\",\n  \"settlement_currency\": \"USDT\",\n  \"settlement_network\": \"TRON\",\n  \"destination_provider_code\": \"044\",\n  \"destination_account_name\": \"Kwame Mensah\",\n  \"merchant_reference\": \"ref_merchant_xyz_001\",\n  \"notification_url\": \"https://merchant.example.com/hooks/this-payout\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.spendin.app/v1/payouts")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"destination_type\": \"MOBILE_MONEY\",\n  \"destination_country\": \"GH\",\n  \"destination_currency\": \"GHS\",\n  \"destination_amount\": 500,\n  \"destination_account_unique\": \"0244000000\",\n  \"destination_provider_name\": \"MTN\",\n  \"settlement_currency\": \"USDT\",\n  \"settlement_network\": \"TRON\",\n  \"destination_provider_code\": \"044\",\n  \"destination_account_name\": \"Kwame Mensah\",\n  \"merchant_reference\": \"ref_merchant_xyz_001\",\n  \"notification_url\": \"https://merchant.example.com/hooks/this-payout\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spendin.app/v1/payouts")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"destination_type\": \"MOBILE_MONEY\",\n  \"destination_country\": \"GH\",\n  \"destination_currency\": \"GHS\",\n  \"destination_amount\": 500,\n  \"destination_account_unique\": \"0244000000\",\n  \"destination_provider_name\": \"MTN\",\n  \"settlement_currency\": \"USDT\",\n  \"settlement_network\": \"TRON\",\n  \"destination_provider_code\": \"044\",\n  \"destination_account_name\": \"Kwame Mensah\",\n  \"merchant_reference\": \"ref_merchant_xyz_001\",\n  \"notification_url\": \"https://merchant.example.com/hooks/this-payout\"\n}"

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

Headers

X-Request-Id

string

Idempotency-Key

string<uuid>

required

Unique idempotency token per logical write (UUID v4). Re-send the same value on safe retries.

Example:

"a1b2c3d4-e5f6-47a8-b9c0-d1e2f3a4b5c6"

Body

application/json

destination_type

enum<string>

required

Available options:

MOBILE_MONEY,

BANK_ACCOUNT,

CRYPTO_WALLET

Example:

"MOBILE_MONEY"

destination_country

string

required

ISO 3166-1 alpha-2 country code

Example:

"GH"

destination_currency

string

required

ISO 4217 currency code

Example:

"GHS"

destination_amount

number

required

Amount the beneficiary receives

Example:

500

destination_account_unique

string

required

Mobile number or bank account number

Example:

"0244000000"

destination_provider_name

string

required

Mobile money provider or bank name

Example:

"MTN"

settlement_currency

string

Currency the merchant settles in — USDT (crypto rail) or NGN (bank transfer). Defaults to USDT.

Example:

"USDT"

settlement_network

enum<string>

Crypto rail only: the chain the merchant will settle on (TRON or BSC). Selects which per-merchant receiving address the payment instruction shows. Ignored on the bank-transfer rail. Defaults to TRON for crypto settlements.

Available options:

TRON,

BSC

Example:

"TRON"

destination_provider_code

string

Machine code for the destination institution — the bank code for BANK_ACCOUNT, the mobile money code for MOBILE_MONEY. Required for both: the processor routes on this code and never on the display name. Omit for CRYPTO_WALLET. Codes are corridor-specific — fetch them from the processor bank list.

Example:

"044"

destination_account_name

string

Beneficiary name. Required for BANK_ACCOUNT and MOBILE_MONEY — the processor rejects a transfer without it.

Example:

"Kwame Mensah"

merchant_reference

string

Example:

"ref_merchant_xyz_001"

notification_url

string

Per-payout webhook override. When set, events for this payout are delivered here instead of the tenant default webhook URL.

Example:

"https://merchant.example.com/hooks/this-payout"

Response

Payout created

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

Create a payout request

Authorizations

Headers

Body

Response