Sign in

778890ee7e72

latestOpenAPI 3.0.02026-08-14100249502.6 KB
Conversions

List conversions

Retrieves a list of conversions for the given account, returned in sorted (by epoch) order (default is newest first).

get/conversions

Query parameters

limitinteger
Example:20

Control how many items are returned in the result list.

ascendingboolean

Control the order (newest or oldest) in which the conversions are returned. false will arrange the results with newest first whereas true shows oldest first.

startsAfterstring
Example:cv_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473

A token to identify the previous item to start querying after. The value of the paginationToken field from that response should be supplied here, to retrieve the next page of results.

startTimestampinteger
Example:1641859200

The start timestamp (inclusive, epoch seconds)

endTimestampinteger
Example:1641945599

The end timestamp (inclusive, epoch seconds)

Headers

Accountstring
Example:ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327

The linked accountId (use this to list conversions for a specific sub account)

Response

Successfully retrieved the conversions

paginationTokenstring nullable

A token to use for getting the next page of results - send the same request with this value in the 'startsAfter' query parameter. This field is null when there are no further items to return.

Example response

{
  "items": [
    {
      "id": "cv_01FCTS1XMKH9FF43CAFA4CXT3P",
      "sell": {
        "amount": 100000,
        "currency": "GBP",
        "fees": {
          "ryft": {
            "amount": 500
          },
          "platform": {
            "amount": 1000,
            "ryftFee": {
              "amount": 500
            }
          }
        }
      },
      "buy": {
        "amount": 86000,
        "currency": "EUR",
        "fees": {
          "ryft": {
            "amount": 500
          },
          "platform": {
            "amount": 1000,
            "ryftFee": {
              "amount": 500
            }
          }
        }
      },
      "rate": 0.86,
      "status": "Settled",
      "reason": "Invoice payment",
      "estimatedSettlementDate": "2024-03-15",
      "settledTimestamp": 1710460800,
      "createdBy": {
        "id": "usr_01FCTS1XMKH9FF43CAFA4CXT3P",
        "name": "John Smith"
      },
      "createdTimestamp": 1710288000
    }
  ],
  "paginationToken": "cv_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"
}