Initiate a business payout

curl --request POST \
  --url http://localhost:3001/api/v1/business/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "<string>",
  "recipientId": "<string>",
  "destination": {},
  "quoteToken": "<string>",
  "amount": "50.00",
  "twoFactorCode": "<string>",
  "metadata": {}
}
'

import requests

url = "http://localhost:3001/api/v1/business/payouts"

payload = {
    "idempotencyKey": "<string>",
    "recipientId": "<string>",
    "destination": {},
    "quoteToken": "<string>",
    "amount": "50.00",
    "twoFactorCode": "<string>",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: '<string>',
    recipientId: '<string>',
    destination: {},
    quoteToken: '<string>',
    amount: '50.00',
    twoFactorCode: '<string>',
    metadata: {}
  })
};

fetch('http://localhost:3001/api/v1/business/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_PORT => "3001",
  CURLOPT_URL => "http://localhost:3001/api/v1/business/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([
    'idempotencyKey' => '<string>',
    'recipientId' => '<string>',
    'destination' => [
        
    ],
    'quoteToken' => '<string>',
    'amount' => '50.00',
    'twoFactorCode' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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 := "http://localhost:3001/api/v1/business/payouts"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"<string>\",\n  \"recipientId\": \"<string>\",\n  \"destination\": {},\n  \"quoteToken\": \"<string>\",\n  \"amount\": \"50.00\",\n  \"twoFactorCode\": \"<string>\",\n  \"metadata\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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("http://localhost:3001/api/v1/business/payouts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"<string>\",\n  \"recipientId\": \"<string>\",\n  \"destination\": {},\n  \"quoteToken\": \"<string>\",\n  \"amount\": \"50.00\",\n  \"twoFactorCode\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/v1/business/payouts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"<string>\",\n  \"recipientId\": \"<string>\",\n  \"destination\": {},\n  \"quoteToken\": \"<string>\",\n  \"amount\": \"50.00\",\n  \"twoFactorCode\": \"<string>\",\n  \"metadata\": {}\n}"

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

{
  "success": true,
  "data": {
    "id": "<string>",
    "businessId": "<string>",
    "rail": "CRYPTO",
    "status": "CREATED",
    "amount": "<string>",
    "currency": "USDC",
    "feeAmount": "<string>",
    "networkFee": "<string>",
    "platformFee": "<string>",
    "totalFee": "<string>",
    "totalDebit": "<string>",
    "destinationMasked": {},
    "createdAt": "<string>",
    "recipientId": "<string>",
    "providerRef": "<string>",
    "failureReason": "<string>",
    "submittedAt": "<string>",
    "settledAt": "<string>",
    "cancelledAt": "<string>",
    "quote": {
      "dstAmount": "<string>",
      "rate": "<string>",
      "axraFee": "<string>",
      "currency": "<string>",
      "country": "<string>"
    }
  }
}

{
  "id": "<string>",
  "businessId": "<string>",
  "rail": "CRYPTO",
  "status": "CREATED",
  "amount": "<string>",
  "currency": "USDC",
  "feeAmount": "<string>",
  "networkFee": "<string>",
  "platformFee": "<string>",
  "totalFee": "<string>",
  "totalDebit": "<string>",
  "destinationMasked": {},
  "createdAt": "<string>",
  "recipientId": "<string>",
  "providerRef": "<string>",
  "failureReason": "<string>",
  "submittedAt": "<string>",
  "settledAt": "<string>",
  "cancelledAt": "<string>",
  "quote": {
    "dstAmount": "<string>",
    "rate": "<string>",
    "axraFee": "<string>",
    "currency": "<string>",
    "country": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

Payouts

Initiate a business payout

Confirms a payout against a signed quoteToken (LOCAL_BANK / LOCAL_MOMO). Name the destination in exactly one of three ways: recipientId for a recipient saved via POST /v1/business/payouts/recipients; inline recipient to send the details on the payout itself; or, for requests authenticated with x-api-key, inline destination. The quote is scoped to corridor, amount and business — never to a recipient — so one token confirms any of the three. Screening differs by channel: dashboard (JWT) payouts are sanctions-screened and a saved recipient carrying a match is refused; x-api-key payouts are not screened by Axra (the merchant is the obligated party under the merchant agreement) and an inline recipient/destination is paid ad hoc rather than saved, so the payout returns recipientId null. Server-to-server payouts are also exempt from the interactive 2FA gate — the controls are the secret key and the per-corridor velocity caps.

POST

api

business

payouts

Initiate a business payout

curl --request POST \
  --url http://localhost:3001/api/v1/business/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "<string>",
  "recipientId": "<string>",
  "destination": {},
  "quoteToken": "<string>",
  "amount": "50.00",
  "twoFactorCode": "<string>",
  "metadata": {}
}
'

import requests

url = "http://localhost:3001/api/v1/business/payouts"

payload = {
    "idempotencyKey": "<string>",
    "recipientId": "<string>",
    "destination": {},
    "quoteToken": "<string>",
    "amount": "50.00",
    "twoFactorCode": "<string>",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: '<string>',
    recipientId: '<string>',
    destination: {},
    quoteToken: '<string>',
    amount: '50.00',
    twoFactorCode: '<string>',
    metadata: {}
  })
};

fetch('http://localhost:3001/api/v1/business/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_PORT => "3001",
  CURLOPT_URL => "http://localhost:3001/api/v1/business/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([
    'idempotencyKey' => '<string>',
    'recipientId' => '<string>',
    'destination' => [
        
    ],
    'quoteToken' => '<string>',
    'amount' => '50.00',
    'twoFactorCode' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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 := "http://localhost:3001/api/v1/business/payouts"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"<string>\",\n  \"recipientId\": \"<string>\",\n  \"destination\": {},\n  \"quoteToken\": \"<string>\",\n  \"amount\": \"50.00\",\n  \"twoFactorCode\": \"<string>\",\n  \"metadata\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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("http://localhost:3001/api/v1/business/payouts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"<string>\",\n  \"recipientId\": \"<string>\",\n  \"destination\": {},\n  \"quoteToken\": \"<string>\",\n  \"amount\": \"50.00\",\n  \"twoFactorCode\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/v1/business/payouts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"<string>\",\n  \"recipientId\": \"<string>\",\n  \"destination\": {},\n  \"quoteToken\": \"<string>\",\n  \"amount\": \"50.00\",\n  \"twoFactorCode\": \"<string>\",\n  \"metadata\": {}\n}"

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

{
  "success": true,
  "data": {
    "id": "<string>",
    "businessId": "<string>",
    "rail": "CRYPTO",
    "status": "CREATED",
    "amount": "<string>",
    "currency": "USDC",
    "feeAmount": "<string>",
    "networkFee": "<string>",
    "platformFee": "<string>",
    "totalFee": "<string>",
    "totalDebit": "<string>",
    "destinationMasked": {},
    "createdAt": "<string>",
    "recipientId": "<string>",
    "providerRef": "<string>",
    "failureReason": "<string>",
    "submittedAt": "<string>",
    "settledAt": "<string>",
    "cancelledAt": "<string>",
    "quote": {
      "dstAmount": "<string>",
      "rate": "<string>",
      "axraFee": "<string>",
      "currency": "<string>",
      "country": "<string>"
    }
  }
}

{
  "id": "<string>",
  "businessId": "<string>",
  "rail": "CRYPTO",
  "status": "CREATED",
  "amount": "<string>",
  "currency": "USDC",
  "feeAmount": "<string>",
  "networkFee": "<string>",
  "platformFee": "<string>",
  "totalFee": "<string>",
  "totalDebit": "<string>",
  "destinationMasked": {},
  "createdAt": "<string>",
  "recipientId": "<string>",
  "providerRef": "<string>",
  "failureReason": "<string>",
  "submittedAt": "<string>",
  "settledAt": "<string>",
  "cancelledAt": "<string>",
  "quote": {
    "dstAmount": "<string>",
    "rate": "<string>",
    "axraFee": "<string>",
    "currency": "<string>",
    "country": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "email must be an email",
    "statusCode": 400,
    "errors": {}
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Axra-Business-Id

string

Active business context

x-api-key

string

Merchant API key (alternative to dashboard JWT)

Body

application/json

Option 1
Option 2
Option 3

rail

enum<string>

required

Available options:

CRYPTO,

ACH,

WIRE,

SEPA,

SWIFT,

LOCAL_BANK,

LOCAL_MOMO

idempotencyKey

string

required

Required string length: 8 - 64

recipientId

string

Saved recipient id. For LOCAL_BANK / LOCAL_MOMO provide exactly one of recipientId, inline recipient, or (api-key only) inline destination. On other rails it is mutually exclusive with destination.

recipient

object

Inline recipient details for LOCAL_BANK / LOCAL_MOMO (mutually exclusive with recipientId). Paid in the same call — a single quote→pay round-trip. Behaviour depends on how the request is authenticated: on the DASHBOARD (JWT) the recipient is sanctions-screened, account-resolved and saved to your recipient book; on the MERCHANT API (x-api-key) it is treated as an ad-hoc destination — not screened by Axra and not saved, so the payout comes back with recipientId null and cannot be reused by id. Use POST /v1/business/payouts/recipients first if you want a reusable recipientId.

Show child attributes

destination

object

Ad-hoc destination, mutually exclusive with recipientId. On LOCAL_BANK / LOCAL_MOMO it is accepted only for requests authenticated with x-api-key; a dashboard (JWT) request must use recipientId or inline recipient. Same fields as the rail's recipient details object. Nothing is persisted to your recipient book, so the payout has recipientId null.

quoteToken

string

Signed quote token from POST /v1/business/payouts/quote (required for LOCAL_BANK / LOCAL_MOMO)

amount

string

Decimal string (up to 8 fractional digits). Ignored for LOCAL_* rails — amounts come from quoteToken.

Pattern: /^[0-9]+(\.[0-9]{1,8})?$/

Example:

"50.00"

currency

enum<string>

Ignored for LOCAL_* rails — wallet debit currency is USDC from the quote.

Available options:

USDC,

EURC,

GBPC,

NGN

twoFactorCode

string

Fresh TOTP code when amount >= $10k USD-equivalent

Required string length: 6

metadata

object

Response

success

boolean

required

Example:

true

data

object

required

Show child attributes

Payout Recipients

Payout Batches

Payout Schedules

Payouts

Authentication

Payments

Payment Links

Customers

Disputes

Webhooks

Fraud

Local Rails

Treasury — KYC

Treasury — End-Users

Treasury — Wallets

Treasury — Payouts

Elements

Initiate a business payout

Authorizations

Headers

Body

Response