Balance Conversions

Balance Conversion resource represents the details of the balance conversion. The balance conversion is the conversion of the balance from one supported currency to another supported currency.

SchemasOperations

BalanceConversion

idstringread-only

The unique identifier for the balance balance.

Example:"conv_6776d57dnbTWj"

fromobject(Money)

the amount and currency of the balance used for conversion

toobject(Money)

the amount and currency of the balance after conversion

feesobject(Money)

Total fees for the conversion

mid_market_rateobject(ConversionRate)

The mid-market rate at the time of conversion

statusstringread-only

The status of the balance conversion.

pending — the conversion has been created and has not completed yet.
success — the converted amount has been credited. Terminal.
failed — the conversion did not complete. Terminal.

Enum:"pending""success""failed"

Example:"success"

created_atstring, (date-time)read-only

When the balance conversion was created, as an ISO 8601 date-time in UTC.

Example:"2021-01-01T00:00:00Z"

{
  "id": "conv_6776d57dnbTWj",
  "from": {
    "amount": 1000,
    "currency": "USD"
  },
  "to": {
    "amount": 1000,
    "currency": "USD"
  },
  "fees": {
    "amount": 1000,
    "currency": "USD"
  },
  "mid_market_rate": {
    "currency": "USD",
    "rate": 1.4
  },
  "status": "success",
  "created_at": "2021-01-01T00:00:00Z"
}