Skip to main content
POST
Create return

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

Deposit to return and optional payment rail.

deposit_id
string<uuid>
required

Deposit to return funds from.

Example:

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

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

Example:

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

type
enum<string>
required

Resource type discriminator.

Available options:
return
status
enum<string>
required

Current status of the return.

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

ID of the parent deposit.

Example:

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

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"

failure
object | null
required

Failure details when status is failed, otherwise null.

Example:

null

initiated_at
string<date-time>
required

ISO 8601 UTC timestamp when the return was initiated.

Example:

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

sent_at
string<date-time> | null
required

ISO 8601 UTC timestamp when the return was sent.

Example:

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

tx_hash
string | null
required

Transaction hash for crypto returns, 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 return, 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
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: