Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Path Parameters

id
string<uuid>
required

Unique identifier of the payout.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$

Response

200 - application/json

The payout resource

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
IBAN · object
required

Bank account or crypto wallet the payout was sent to.

reference
string
required

Payment reference.

failure
object | null
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.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updated_at
string<date-time>
required

ISO 8601 UTC timestamp when the payout was last updated.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$