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

Response

200 - application/json

The return resource

id
string<uuid>
required

Unique identifier of the return.

type
enum<string>
required

Type of the resource.

Available options:
return
status
enum<string>
required

Current status of the return.

Available options:
pending,
paid,
failed,
returned
deposit_id
string<uuid>
required

ID of the parent deposit.

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

Failure details when status is failed, otherwise null.

created_at
string<date-time>
required

ISO 8601 UTC timestamp when the return was created.

updated_at
string<date-time>
required

ISO 8601 UTC timestamp when the return was last updated.