Create a payout

curl --request POST \
  --url https://api.withacclaim.com/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "treasury_account_id": "<string>",
  "payee_id": "<string>",
  "funded_amount": 125000,
  "payment_amount": 125000,
  "payment_currency": "USD",
  "reference": "<string>",
  "description": "<string>",
  "purpose_of_payment": "ClaimReimbursement",
  "payout_method_id": "pom_1a2b3c4d5e",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  },
  "line_items": [
    {
      "amount": 10000,
      "currency": "USD",
      "description": "<string>",
      "reference": "<string>",
      "metadata": {}
    }
  ]
}
'

import requests

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

payload = {
    "treasury_account_id": "<string>",
    "payee_id": "<string>",
    "funded_amount": 125000,
    "payment_amount": 125000,
    "payment_currency": "USD",
    "reference": "<string>",
    "description": "<string>",
    "purpose_of_payment": "ClaimReimbursement",
    "payout_method_id": "pom_1a2b3c4d5e",
    "metadata": {
        "custom_field": "value",
        "source": "api"
    },
    "line_items": [
        {
            "amount": 10000,
            "currency": "USD",
            "description": "<string>",
            "reference": "<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({
    treasury_account_id: '<string>',
    payee_id: '<string>',
    funded_amount: 125000,
    payment_amount: 125000,
    payment_currency: 'USD',
    reference: '<string>',
    description: '<string>',
    purpose_of_payment: 'ClaimReimbursement',
    payout_method_id: 'pom_1a2b3c4d5e',
    metadata: {custom_field: 'value', source: 'api'},
    line_items: [
      {
        amount: 10000,
        currency: 'USD',
        description: '<string>',
        reference: '<string>',
        metadata: {}
      }
    ]
  })
};

fetch('https://api.withacclaim.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.withacclaim.com/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([
    'treasury_account_id' => '<string>',
    'payee_id' => '<string>',
    'funded_amount' => 125000,
    'payment_amount' => 125000,
    'payment_currency' => 'USD',
    'reference' => '<string>',
    'description' => '<string>',
    'purpose_of_payment' => 'ClaimReimbursement',
    'payout_method_id' => 'pom_1a2b3c4d5e',
    'metadata' => [
        'custom_field' => 'value',
        'source' => 'api'
    ],
    'line_items' => [
        [
                'amount' => 10000,
                'currency' => 'USD',
                'description' => '<string>',
                'reference' => '<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 := "https://api.withacclaim.com/v1/payouts"

	payload := strings.NewReader("{\n  \"treasury_account_id\": \"<string>\",\n  \"payee_id\": \"<string>\",\n  \"funded_amount\": 125000,\n  \"payment_amount\": 125000,\n  \"payment_currency\": \"USD\",\n  \"reference\": \"<string>\",\n  \"description\": \"<string>\",\n  \"purpose_of_payment\": \"ClaimReimbursement\",\n  \"payout_method_id\": \"pom_1a2b3c4d5e\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  },\n  \"line_items\": [\n    {\n      \"amount\": 10000,\n      \"currency\": \"USD\",\n      \"description\": \"<string>\",\n      \"reference\": \"<string>\",\n      \"metadata\": {}\n    }\n  ]\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("https://api.withacclaim.com/v1/payouts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"treasury_account_id\": \"<string>\",\n  \"payee_id\": \"<string>\",\n  \"funded_amount\": 125000,\n  \"payment_amount\": 125000,\n  \"payment_currency\": \"USD\",\n  \"reference\": \"<string>\",\n  \"description\": \"<string>\",\n  \"purpose_of_payment\": \"ClaimReimbursement\",\n  \"payout_method_id\": \"pom_1a2b3c4d5e\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  },\n  \"line_items\": [\n    {\n      \"amount\": 10000,\n      \"currency\": \"USD\",\n      \"description\": \"<string>\",\n      \"reference\": \"<string>\",\n      \"metadata\": {}\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"treasury_account_id\": \"<string>\",\n  \"payee_id\": \"<string>\",\n  \"funded_amount\": 125000,\n  \"payment_amount\": 125000,\n  \"payment_currency\": \"USD\",\n  \"reference\": \"<string>\",\n  \"description\": \"<string>\",\n  \"purpose_of_payment\": \"ClaimReimbursement\",\n  \"payout_method_id\": \"pom_1a2b3c4d5e\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  },\n  \"line_items\": [\n    {\n      \"amount\": 10000,\n      \"currency\": \"USD\",\n      \"description\": \"<string>\",\n      \"reference\": \"<string>\",\n      \"metadata\": {}\n    }\n  ]\n}"

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

{
  "id": "po_dlZwQyd0Sn",
  "treasury_account_id": "tac_b0TrsSg91h",
  "payee_id": "pyee_KfIuLz83Ya",
  "batch_id": "pob_r8PxTnQ5Dv",
  "funded_amount": 125000,
  "funding_currency": "USD",
  "payment_amount": 125000,
  "payment_currency": "USD",
  "exchange_rate": "1.00000000",
  "payout_link_url": "<string>",
  "payout_method": {
    "id": "pmet_abc123",
    "payout_method_type": "UnitedStatesAch",
    "active": true,
    "currency": "<string>",
    "country": "<string>",
    "account_number": "<string>",
    "routing_type1": "<string>",
    "routing_value1": "<string>",
    "routing_type2": "<string>",
    "routing_value2": "<string>",
    "bank_name": "<string>",
    "account_holder_name": "<string>",
    "account_type": "<string>",
    "swift_code": "<string>",
    "iban": "<string>",
    "tax_id_type": "<string>",
    "tax_id": "<string>",
    "payout_speed": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "reference": "REF-2025-001",
  "description": "Payment for services rendered",
  "processed_at": "2025-10-08T18:25:00Z",
  "payment_date": "2025-10-08",
  "failure_code": "insufficient_funds",
  "failure_message": "Insufficient funds in treasury account",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  },
  "created_at": "2025-10-08T18:20:31Z",
  "updated_at": "2025-10-08T18:25:00Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: amount",
    "details": {},
    "request_id": "req_7lYt4o2x"
  }
}

POST

payouts

Create a payout

curl --request POST \
  --url https://api.withacclaim.com/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "treasury_account_id": "<string>",
  "payee_id": "<string>",
  "funded_amount": 125000,
  "payment_amount": 125000,
  "payment_currency": "USD",
  "reference": "<string>",
  "description": "<string>",
  "purpose_of_payment": "ClaimReimbursement",
  "payout_method_id": "pom_1a2b3c4d5e",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  },
  "line_items": [
    {
      "amount": 10000,
      "currency": "USD",
      "description": "<string>",
      "reference": "<string>",
      "metadata": {}
    }
  ]
}
'

import requests

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

payload = {
    "treasury_account_id": "<string>",
    "payee_id": "<string>",
    "funded_amount": 125000,
    "payment_amount": 125000,
    "payment_currency": "USD",
    "reference": "<string>",
    "description": "<string>",
    "purpose_of_payment": "ClaimReimbursement",
    "payout_method_id": "pom_1a2b3c4d5e",
    "metadata": {
        "custom_field": "value",
        "source": "api"
    },
    "line_items": [
        {
            "amount": 10000,
            "currency": "USD",
            "description": "<string>",
            "reference": "<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({
    treasury_account_id: '<string>',
    payee_id: '<string>',
    funded_amount: 125000,
    payment_amount: 125000,
    payment_currency: 'USD',
    reference: '<string>',
    description: '<string>',
    purpose_of_payment: 'ClaimReimbursement',
    payout_method_id: 'pom_1a2b3c4d5e',
    metadata: {custom_field: 'value', source: 'api'},
    line_items: [
      {
        amount: 10000,
        currency: 'USD',
        description: '<string>',
        reference: '<string>',
        metadata: {}
      }
    ]
  })
};

fetch('https://api.withacclaim.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.withacclaim.com/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([
    'treasury_account_id' => '<string>',
    'payee_id' => '<string>',
    'funded_amount' => 125000,
    'payment_amount' => 125000,
    'payment_currency' => 'USD',
    'reference' => '<string>',
    'description' => '<string>',
    'purpose_of_payment' => 'ClaimReimbursement',
    'payout_method_id' => 'pom_1a2b3c4d5e',
    'metadata' => [
        'custom_field' => 'value',
        'source' => 'api'
    ],
    'line_items' => [
        [
                'amount' => 10000,
                'currency' => 'USD',
                'description' => '<string>',
                'reference' => '<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 := "https://api.withacclaim.com/v1/payouts"

	payload := strings.NewReader("{\n  \"treasury_account_id\": \"<string>\",\n  \"payee_id\": \"<string>\",\n  \"funded_amount\": 125000,\n  \"payment_amount\": 125000,\n  \"payment_currency\": \"USD\",\n  \"reference\": \"<string>\",\n  \"description\": \"<string>\",\n  \"purpose_of_payment\": \"ClaimReimbursement\",\n  \"payout_method_id\": \"pom_1a2b3c4d5e\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  },\n  \"line_items\": [\n    {\n      \"amount\": 10000,\n      \"currency\": \"USD\",\n      \"description\": \"<string>\",\n      \"reference\": \"<string>\",\n      \"metadata\": {}\n    }\n  ]\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("https://api.withacclaim.com/v1/payouts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"treasury_account_id\": \"<string>\",\n  \"payee_id\": \"<string>\",\n  \"funded_amount\": 125000,\n  \"payment_amount\": 125000,\n  \"payment_currency\": \"USD\",\n  \"reference\": \"<string>\",\n  \"description\": \"<string>\",\n  \"purpose_of_payment\": \"ClaimReimbursement\",\n  \"payout_method_id\": \"pom_1a2b3c4d5e\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  },\n  \"line_items\": [\n    {\n      \"amount\": 10000,\n      \"currency\": \"USD\",\n      \"description\": \"<string>\",\n      \"reference\": \"<string>\",\n      \"metadata\": {}\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"treasury_account_id\": \"<string>\",\n  \"payee_id\": \"<string>\",\n  \"funded_amount\": 125000,\n  \"payment_amount\": 125000,\n  \"payment_currency\": \"USD\",\n  \"reference\": \"<string>\",\n  \"description\": \"<string>\",\n  \"purpose_of_payment\": \"ClaimReimbursement\",\n  \"payout_method_id\": \"pom_1a2b3c4d5e\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  },\n  \"line_items\": [\n    {\n      \"amount\": 10000,\n      \"currency\": \"USD\",\n      \"description\": \"<string>\",\n      \"reference\": \"<string>\",\n      \"metadata\": {}\n    }\n  ]\n}"

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

{
  "id": "po_dlZwQyd0Sn",
  "treasury_account_id": "tac_b0TrsSg91h",
  "payee_id": "pyee_KfIuLz83Ya",
  "batch_id": "pob_r8PxTnQ5Dv",
  "funded_amount": 125000,
  "funding_currency": "USD",
  "payment_amount": 125000,
  "payment_currency": "USD",
  "exchange_rate": "1.00000000",
  "payout_link_url": "<string>",
  "payout_method": {
    "id": "pmet_abc123",
    "payout_method_type": "UnitedStatesAch",
    "active": true,
    "currency": "<string>",
    "country": "<string>",
    "account_number": "<string>",
    "routing_type1": "<string>",
    "routing_value1": "<string>",
    "routing_type2": "<string>",
    "routing_value2": "<string>",
    "bank_name": "<string>",
    "account_holder_name": "<string>",
    "account_type": "<string>",
    "swift_code": "<string>",
    "iban": "<string>",
    "tax_id_type": "<string>",
    "tax_id": "<string>",
    "payout_speed": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "reference": "REF-2025-001",
  "description": "Payment for services rendered",
  "processed_at": "2025-10-08T18:25:00Z",
  "payment_date": "2025-10-08",
  "failure_code": "insufficient_funds",
  "failure_message": "Insufficient funds in treasury account",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  },
  "created_at": "2025-10-08T18:20:31Z",
  "updated_at": "2025-10-08T18:25:00Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: amount",
    "details": {},
    "request_id": "req_7lYt4o2x"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

treasury_account_id

string

required

ID of the treasury account to payout from

payee_id

string

required

ID of the payee to receive the payout

funded_amount

integer

Amount in smallest currency unit from the treasury account

Required range: x >= 1

Example:

125000

payment_amount

integer

Amount in smallest currency unit to send to the payee (after currency conversion)

Required range: x >= 1

Example:

125000

payment_currency

string

ISO 4217 currency code for the payment amount (3 uppercase letters)

Required string length: 3

Pattern: ^[A-Z]{3}$

Example:

"USD"

reference

string

Optional client reference for reconciliation

description

string

Optional description for the payout

Maximum string length: 255

purpose_of_payment

enum<string>

Purpose of the payment

Available options:

ProviderBillPayment,

Commission,

Refund,

ClaimReimbursement

Example:

"ClaimReimbursement"

payout_method_id

string

ID of the payout method to use for this payout

Example:

"pom_1a2b3c4d5e"

metadata

object | null

Optional metadata as key-value pairs

Example:

{ "custom_field": "value", "source": "api" }

line_items

object[]

Optional line-item breakdown. If omitted or empty, the payout will have no line items.

Maximum array length: 500

Show child attributes

Response

Payout created.

string

Example:

"po_dlZwQyd0Sn"

treasury_account_id

string | null

ID of the treasury account funding the payout

Example:

"tac_b0TrsSg91h"

payee_id

string

ID of the payee

Example:

"pyee_KfIuLz83Ya"

batch_id

string | null

ID of the payout batch if this payout belongs to one

Example:

"pob_r8PxTnQ5Dv"

funded_amount

integer | null

The amount funded from the treasury account in smallest currency unit

Example:

125000

funding_currency

string | null

ISO 4217 currency code for the funded amount

Example:

"USD"

payment_amount

integer | null

Amount sent to payee in smallest currency unit (after currency conversion)

Example:

125000

payment_currency

string | null

ISO 4217 currency code for the payment amount

Example:

"USD"

exchange_rate

string | null

Exchange rate used for currency conversion (if applicable)

Example:

"1.00000000"

status

enum<string>

Available options:

ReadyToProcess,

Processing,

Succeeded,

Failed,

Canceled,

RequiresPayeeInfo,

RequiresAction,

RequiresPayoutMethod,

NeedsApproval

payout_link_url

string<uri> | null

URL for the payout link if generated for recipient choice

payout_method

object | null

The payout method used for this payout

Show child attributes

reference

string | null

Client-supplied reference for reconciliation

Example:

"REF-2025-001"

description

string | null

Example:

"Payment for services rendered"

purpose_of_payment

enum<string> | null

Purpose of the payment

Available options:

ProviderBillPayment,

Commission,

Refund,

ClaimReimbursement

processed_at

string<date-time> | null

When the payout was processed

Example:

"2025-10-08T18:25:00Z"

payment_date

string<date> | null

Expected or actual payment date

Example:

"2025-10-08"

swift_charge_option

enum<string> | null

SWIFT charge option (for international wire transfers)

Available options:

Our,

Shared,

Beneficiary

lock_side

enum<string>

Which side of the FX quote has a locked rate. Funding means the funded amount is fixed; Payment means the payment amount is fixed.

Available options:

Funding,

Payment

failure_code

string | null

Error code if the payout failed

Example:

"insufficient_funds"

failure_message

string | null

Human-readable error message if the payout failed

Example:

"Insufficient funds in treasury account"

metadata

object | null

Optional metadata as key-value pairs

Example:

{ "custom_field": "value", "source": "api" }

created_at

string<date-time>

Example:

"2025-10-08T18:20:31Z"

updated_at

string<date-time>

Example:

"2025-10-08T18:25:00Z"

Last modified on June 14, 2026

List payouts

Retrieve a payout

⌘I

ACCLAIM API

COLLECT API

DISBURSE API

TREASURY API

Create a payout

Authorizations

Body

Response