Payouts

Create payout

Changed on

Creates a new payout.

post/v1/payouts

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/payouts
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring 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.

Request body

account_idstring uuid required

ID of the account to debit.

amountstring required

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

currency'EUR' | 'GBP' | 'USD' | 'USDC' required

Currency code (ISO 4217 or crypto).

counterparty_idstring uuid required

ID of the saved counterparty that receives the money.

rail'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'ach' | 'fedwire' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy'

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

unstructured_remittance_informationstring nullable

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

metadataobject nullable

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 request

{
  "account_id": "550e8400-e29b-41d4-a716-44665544000b",
  "amount": "100.50",
  "currency": "USD",
  "counterparty_id": "550e8400-e29b-41d4-a716-446655440000",
  "unstructured_remittance_information": "INV-2026-0042",
  "metadata": {
    "invoice_id": "INV-2026-0042"
  }
}

Response

Success

idstring uuid required

Unique identifier of the payout.

type'payout' required

Resource type discriminator.

status'initiated' | 'submitted' | 'sent' | 'failed' | 'returned' required

Current status of the payout.

account_idstring uuid required

ID of the account that was debited.

amountstring required

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

currency'EUR' | 'GBP' | 'USD' | 'USDC' required

Currency code (ISO 4217 or crypto).

counterparty_idstring uuid required

ID of the counterparty that receives the money.

unstructured_remittance_informationstring nullable required

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

metadataobject 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.

initiated_atstring date-time required

ISO 8601 UTC timestamp when the payout was initiated.

sent_atstring date-time nullable required

ISO 8601 UTC timestamp when the payout was sent.

tx_hashstring nullable required

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

rail'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy' | 'null' nullable required

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

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440003",
  "status": "sent",
  "account_id": "550e8400-e29b-41d4-a716-446655440001",
  "amount": "100.50",
  "currency": "USD",
  "counterparty_id": "550e8400-e29b-41d4-a716-446655440000",
  "unstructured_remittance_information": "INV-2026-0042",
  "tracking_reference": {
    "type": "uetr",
    "value": "550e8400-e29b-41d4-a716-446655440000"
  },
  "metadata": {
    "invoice_id": "INV-2026-0042"
  },
  "initiated_at": "2026-01-15T10:30:00Z",
  "sent_at": "2026-01-15T10:35:00Z",
  "rail": "ach"
}

Changes