Retrieve conversion

Retrieves a conversion by ID.

GET /v1/conversions/{id}

JavaScript

JavaScript

import Augustus from '@augustusbank/typescript-sdk';

const client = new Augustus({
  apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});

const conversion = await client.conversions.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(conversion.id);

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_amount": "<string>",
  "source_account_id": "<string>",
  "target_account_id": "<string>",
  "failure": {
    "message": "<string>"
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer token for authentication with Augustus Banking API

Path Parameters

id · string<uuid> · required

Unique identifier of the conversion.

Response

200 - application/json

The conversion resource

id · string<uuid> · required

Unique identifier of the conversion.

quote_id · string<uuid> | null · required

ID of the associated quote, or null.

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

Source amount as a string decimal.

source_currency · enum<string> · required

Source currency code.

Available options: EUR, GBP, USD, USDC

target_currency · enum<string> · required

Target currency code.

Available options: EUR, GBP, USD, USDC

source_account_id · string | null · required

ID of the source account, or null.

target_account_id · string | null · required

ID of the target account, or null.

failure · object · required

Failure details when status is failed, otherwise null.

Show child attributes

metadata · object · required

Key-value pairs stored with the conversion.

Show child attributes

created_at · string<date-time> · required

ISO 8601 UTC timestamp when the conversion was created.

updated_at · string<date-time> · required

ISO 8601 UTC timestamp when the conversion was last updated.

completed_at · string<date-time> | null · required

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