Skip to main content
POST
Create conversion

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

Conversion parameters

source_account_id
string<uuid>
required

ID of the source account to debit.

Example:

"550e8400-e29b-41d4-a716-44665544000b"

target_account_id
string<uuid>
required

ID of the target account to credit.

Example:

"550e8400-e29b-41d4-a716-44665544000c"

source_amount
string
required

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

Pattern: ^\d+(\.\d+)?$
Example:

"100.50"

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

Example:

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

type
enum<string>
required

Resource type discriminator.

Available options:
conversion
status
enum<string>
required

Current status of the conversion.

Available options:
pending,
completed,
failed
source_amount
string
required

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

Example:

"100.50"

target_amount
string
required

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

Example:

"100.50"

source_account_id
string<uuid> | null
required

ID of the source account, or null.

Example:

"550e8400-e29b-41d4-a716-44665544000b"

target_account_id
string<uuid> | null
required

ID of the target account, or null.

Example:

"550e8400-e29b-41d4-a716-44665544000c"

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:
created_at
string<date-time>
required

ISO 8601 UTC timestamp when the conversion was created.

Example:

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

updated_at
string<date-time>
required

ISO 8601 UTC timestamp when the conversion was last updated.

Example:

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

completed_at
string<date-time> | null
required

ISO 8601 UTC timestamp when the conversion completed, or null.

Example:

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