Skip to main content
POST
/
v1
/
payouts
Create a payout
curl --request POST \
  --url https://api.leanrails.com/v1/payouts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 2,
  "currency": "<string>",
  "description": "<string>",
  "destination": "<string>",
  "method": "standard",
  "statement_descriptor": "<string>",
  "metadata": {}
}
'
{
  "id": "po_xxx",
  "object": "payout",
  "amount": 123,
  "currency": "<string>",
  "status": "pending",
  "method": "standard",
  "type": "bank_account",
  "arrival_date": 123,
  "automatic": true,
  "source_type": "<string>",
  "reconciliation_status": "<string>",
  "metadata": {},
  "created": 123,
  "livemode": true,
  "destination": "<string>",
  "description": "<string>",
  "statement_descriptor": "<string>",
  "balance_transaction": "<string>",
  "failure_balance_transaction": "<string>",
  "failure_code": "<string>",
  "failure_message": "<string>",
  "original_payout": "<string>",
  "reversed_by": "<string>",
  "canceled_at": 123,
  "failed_at": 123,
  "paid_at": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.fluveo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Use your secret API key as the username with an empty password.

Headers

Idempotency-Key
string
required

Unique key to ensure idempotent requests.

Maximum string length: 255
X-API-Version
string

Override the API version for this request.

Body

application/json
amount
integer
required

Amount to pay out in smallest currency unit (e.g. cents).

Required range: x >= 1
currency
string
required

Three-letter ISO currency code.

Required string length: 3
description
string

An arbitrary string description.

Maximum string length: 1000
destination
string

ID of the external account to pay out to. Defaults to the default external account.

method
enum<string>

Payout method. Defaults to standard.

Available options:
standard,
instant
statement_descriptor
string

Statement descriptor for the payout.

Maximum string length: 22
metadata
object

Set of key-value pairs for storing additional information.

Response

The created Payout.

id
string
required
Example:

"po_xxx"

object
enum<string>
required
Available options:
payout
amount
integer
required

Amount in smallest currency unit.

currency
string
required

Three-letter ISO currency code.

status
enum<string>
required

Current status of the payout.

Available options:
pending,
paid,
failed,
canceled
method
enum<string>
required

Payout speed.

Available options:
standard,
instant
type
enum<string>
required

Destination type.

Available options:
bank_account
arrival_date
integer
required

Unix timestamp of expected arrival date.

automatic
boolean
required

Whether this payout was created automatically.

source_type
string
required

Source balance type (e.g. card, bank_account).

reconciliation_status
string
required
metadata
object
required

Set of key-value pairs for storing additional information.

created
integer
required

Unix timestamp.

livemode
boolean
required
destination
string | null

ID of the destination external account.

description
string | null
statement_descriptor
string | null
balance_transaction
string | null

ID of the balance transaction for this payout.

failure_balance_transaction
string | null
failure_code
string | null
failure_message
string | null
original_payout
string | null
reversed_by
string | null
canceled_at
integer | null

Unix timestamp when canceled.

failed_at
integer | null

Unix timestamp when failed.

paid_at
integer | null

Unix timestamp when paid.