Skip to main content
POST
Create payout

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Headers

Idempotency-Key
string
required

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Body

application/json

Payout creation parameters

account_id
string<uuid>
required

ID of the account to debit.

Example:

"550e8400-e29b-41d4-a716-44665544000b"

amount
string
required

Amount as a string decimal (e.g. "100.50").

Example:

"100.50"

currency
enum<string>
required

Currency code (ISO 4217 or crypto).

Available options:
EUR,
GBP,
USD,
USDC
Example:

"EUR"

counterparty_id
string<uuid>
required

ID of the saved counterparty that receives the money.

Example:

"550e8400-e29b-41d4-a716-446655440000"

rail
enum<string>

Settlement rail the counterparty is reachable on. Selected automatically when omitted. Validated against the counterparty financial address at runtime.

Available options:
sepa,
sepa_instant,
faster_payments,
swift,
ach,
fedwire,
ethereum,
ethereum_sepolia,
solana,
solana_devnet,
polygon,
polygon_amoy
unstructured_remittance_information
string | null

Unstructured remittance information attached to the transfer. This appears on the counterparty's bank statement. Not supported by blockchain rails.

Maximum string length: 140
Example:

"INV-2026-0042"

metadata
object | null

Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

Example:

Response

200 - application/json

Success

id
string<uuid>
required

Unique identifier of the payout.

Example:

"550e8400-e29b-41d4-a716-446655440003"

type
enum<string>
required

Resource type discriminator.

Available options:
payout
status
enum<string>
required

Current status of the payout.

Available options:
initiated,
submitted,
sent,
failed,
returned
account_id
string<uuid>
required

ID of the account that was debited.

Example:

"550e8400-e29b-41d4-a716-446655440001"

amount
string
required

Amount as a string decimal (e.g. "100.50").

Example:

"100.50"

currency
enum<string>
required

Currency code (ISO 4217 or crypto).

Available options:
EUR,
GBP,
USD,
USDC
Example:

"EUR"

counterparty_id
string<uuid>
required

ID of the counterparty that receives the money.

Example:

"550e8400-e29b-41d4-a716-446655440000"

unstructured_remittance_information
string | null
required

Unstructured remittance information attached to the transfer. Not all rails support this field.

Example:

"INV-2026-0042"

tracking_reference
string | null
required

Reference used to track the payment across the payment network, such as the UETR for SWIFT payments.

Example:

"550e8400-e29b-41d4-a716-44665544000d"

failure
object | null
required

Failure details when status is failed, otherwise null.

Example:

null

metadata
object
required

Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

Example:
initiated_at
string<date-time>
required

ISO 8601 UTC timestamp when the payout was initiated.

Example:

"2026-01-15T10:30:00Z"

sent_at
string<date-time> | null
required

ISO 8601 UTC timestamp when the payout was sent.

Example:

"2026-01-15T10:35:00Z"

tx_hash
string | null
required

Transaction hash for crypto payouts, or null when not known. Only blockchain rails support this field.

Example:

null

rail
enum<string> | null
required

Payment scheme or blockchain used for the payout, or null when unknown.

Available options:
sepa,
sepa_instant,
faster_payments,
swift,
internal,
target,
ach,
fedwire,
bitcoin,
bitcoin_testnet4,
ethereum,
ethereum_sepolia,
solana,
solana_devnet,
polygon,
polygon_amoy,
null