Skip to main content
POST
/
v1
/
payouts
JavaScript
import Augustus from '@augustusbank/typescript-sdk';

const client = new Augustus({
  apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});

const payout = await client.payouts.create({
  amount: 'amount',
  currency: 'EUR',
  destination: {
    account_holder_name: 'account_holder_name',
    iban: 'iban',
    type: 'iban',
  },
  reference: 'reference',
  source_account_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});

console.log(payout.id);
{
  "id": "<string>",
  "type": "payout",
  "status": "pending",
  "source_account_id": "<string>",
  "amount": "<string>",
  "currency": "EUR",
  "destination": {
    "type": "iban",
    "iban": "<string>",
    "account_holder_name": "<string>",
    "bic": "<string>"
  },
  "reference": "<string>",
  "failure": {
    "code": "account_closed",
    "message": "<string>",
    "retry": true
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

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

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

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Headers

Idempotency-Key
string

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

source_account_id
string<uuid>
required

ID of the account to debit.

amount
string
required

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

currency
enum<string>
required

Currency for the payout.

Available options:
EUR,
GBP,
USD,
USDC
destination
object
required

Bank account or crypto wallet to send funds to.

reference
string
required

Payment reference.

Maximum string length: 140
rail
enum<string>

Payment rail. It is enforced when provided, otherwise auto-selected.

Available options:
sepa_instant,
sepa,
faster_payments
metadata
object

Key-value pairs stored with the payout.

Response

200 - application/json

Success

id
string
required

Unique identifier of the payout.

type
enum<string>
required

Resource type discriminator.

Available options:
payout
status
enum<string>
required

Current status of the payout.

Available options:
pending,
paid,
failed,
returned
source_account_id
string
required

ID of the account that was debited.

amount
string
required

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

currency
enum<string>
required

Currency code (ISO 4217 currency code or crypto currency code).

Available options:
EUR,
GBP,
USD,
USDC
destination
object
required

Bank account or crypto wallet the payout was sent to.

reference
string
required

Payment reference.

failure
object
required

Failure details when status is failed, otherwise null.

metadata
object
required

Key-value pairs stored with the payout.

created_at
string<date-time>
required

ISO 8601 UTC timestamp when the payout was created.

updated_at
string<date-time>
required

ISO 8601 UTC timestamp when the payout was last updated.