Conversions

Retrieve conversion

Changed on

Retrieves a conversion by ID.

get/v1/conversions/{id}

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/conversions/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440006

Unique identifier of the conversion.

Response

The conversion resource

idstring uuid required

Unique identifier of the conversion.

type'conversion' required

Resource type discriminator.

status'pending' | 'completed' | 'failed' required

Current status of the conversion.

source_amountstring required

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

target_amountstring required

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

source_account_idstring uuid nullable required

ID of the source account, or null.

target_account_idstring uuid nullable required

ID of the target account, or null.

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

created_atstring date-time required

ISO 8601 UTC timestamp when the conversion was created.

updated_atstring date-time required

ISO 8601 UTC timestamp when the conversion was last updated.

completed_atstring date-time nullable required

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

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440006",
  "source_amount": "100.50",
  "target_amount": "100.50",
  "source_account_id": "550e8400-e29b-41d4-a716-44665544000b",
  "target_account_id": "550e8400-e29b-41d4-a716-44665544000c",
  "metadata": {
    "invoice_id": "INV-2026-0042"
  },
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:35:00Z",
  "completed_at": "2026-01-15T10:36:00Z"
}

Changes

  • f7ded6c181abRevision changes
    • info

      endpoint added

  • 79d607871de9Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status