/v2/conversions/find

GET

Find conversions based on search parameters.

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

Required
NameInTypeDescriptionEnumItemsDefault
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescriptionEnumItemsDefault
on_behalf_of query string Contact UUID.
short_reference query string Short reference code.
status query string Conversion status. awaiting_funds
funds_sent
funds_arrived
trade_settled
closed
partner_status query string Conversion status, as displayed to contacts of the sub-account. awaiting_funds
funds_sent
funds_arrived
trade_settled
closed
buy_currency query string The currency purchased. Three-digital code.
sell_currency query string The currency sold. Three-digit code.
conversion_ids[] query array One or more conversion UUIDs to filter out of results. string
created_at_from query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
created_at_to query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
updated_at_from query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
updated_at_to query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
conversion_date_from query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
conversion_date_to query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
currency_pair query string Concatenated string of the two currencies traded, eg. "USDEUR".
partner_buy_amount_from query string Minimum buy amount (sub-accounts).
partner_buy_amount_to query string Maximum buy amount (sub-accounts).
partner_sell_amount_from query string Minimum sell amount (sub-accounts).
partner_sell_amount_to query string Maximum sell amount (sub-accounts).
buy_amount_from query string Minimum buy amount.
buy_amount_to query string Maximum buy amount.
sell_amount_from query string Minimum sell amount.
sell_amount_to query string Maximum sell amount.
scope query string "Own" account, "clients" sub-accounts, or "all" accounts. all
clients
own
own
settlement_date_from query string Earliest date when sold currency debited. Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
settlement_date_to query string Latest date when sold currency debited. Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
unique_request_id query string User-generated idempotency key.
bulk_upload_id query string Bulk upload reference code.
page query integer Page number.
per_page query integer Number of results per page.
order query integer Any field name to change the sort order.
order_asc_desc query string Sort records in ascending or descending order. asc
desc
asc
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/conversions/find

Response

{
    "conversions": [
        {
            "id": "7b8a99d4-8cca-4e3a-aee1-65cf9e7eab21",
            "settlement_date": "2018-04-30T15:30:00+00:00",
            "conversion_date": "2018-04-30T00:00:00+00:00",
            "short_reference": "20180426-JZVBHW",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "100.00",
            "client_sell_amount": "70.93",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-26T15:05:12+00:00",
            "updated_at": "2018-06-25T09:38:38+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "d8d48ff3-0a88-425f-a136-dda00614a6fc",
            "settlement_date": "2018-04-30T15:30:00+00:00",
            "conversion_date": "2018-04-30T00:00:00+00:00",
            "short_reference": "20180426-FBYXZM",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-26T18:29:05+00:00",
            "updated_at": "2018-04-26T18:29:06+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "2e4404d4-2a09-4531-819f-4deb0b44a944",
            "settlement_date": "2018-04-30T15:30:00+00:00",
            "conversion_date": "2018-04-30T00:00:00+00:00",
            "short_reference": "20180426-YPBTTK",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-26T18:47:18+00:00",
            "updated_at": "2018-04-26T18:47:18+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "d893ad5d-ce24-4c4f-bfdb-9f261fe78f9c",
            "settlement_date": "2018-04-30T15:30:00+00:00",
            "conversion_date": "2018-04-30T00:00:00+00:00",
            "short_reference": "20180426-RHYZMF",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-26T18:50:22+00:00",
            "updated_at": "2018-04-26T18:50:22+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "67ad6a0f-7da0-43cc-a540-aa70343186c7",
            "settlement_date": "2018-04-30T15:30:00+00:00",
            "conversion_date": "2018-04-30T00:00:00+00:00",
            "short_reference": "20180426-VMQGJJ",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-26T19:01:25+00:00",
            "updated_at": "2018-04-26T19:01:26+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "bdc6406a-3c06-4162-8a8d-6aed8885a32d",
            "settlement_date": "2018-04-30T15:30:00+00:00",
            "conversion_date": "2018-04-30T00:00:00+00:00",
            "short_reference": "20180426-BRTNMS",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-26T19:11:02+00:00",
            "updated_at": "2018-04-26T19:11:03+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "fc8706c0-b3e8-4672-ba58-48e1592ecc82",
            "settlement_date": "2018-04-30T15:30:00+00:00",
            "conversion_date": "2018-04-30T00:00:00+00:00",
            "short_reference": "20180426-FYMHFZ",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-26T19:16:41+00:00",
            "updated_at": "2018-04-26T19:16:42+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "235938e5-32b0-4f03-ae7d-ef027d7671d3",
            "settlement_date": "2018-05-01T15:30:00+00:00",
            "conversion_date": "2018-05-01T00:00:00+00:00",
            "short_reference": "20180427-DSDZXV",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-27T07:03:10+00:00",
            "updated_at": "2018-04-27T07:03:10+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "2401a458-5565-42a6-9bc2-366e48aaf497",
            "settlement_date": "2018-05-01T15:30:00+00:00",
            "conversion_date": "2018-05-01T00:00:00+00:00",
            "short_reference": "20180427-CTZLWZ",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-27T10:07:38+00:00",
            "updated_at": "2018-04-27T10:07:38+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "304fff32-c4ed-451b-95da-ef4070412400",
            "settlement_date": "2018-05-01T15:30:00+00:00",
            "conversion_date": "2018-05-01T00:00:00+00:00",
            "short_reference": "20180427-FLJQMX",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-27T10:39:33+00:00",
            "updated_at": "2018-04-27T10:39:33+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "f774ef60-465a-4819-9e90-eb5f8957946b",
            "settlement_date": "2018-05-01T15:30:00+00:00",
            "conversion_date": "2018-05-01T00:00:00+00:00",
            "short_reference": "20180427-CTVNKJ",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-27T10:45:28+00:00",
            "updated_at": "2018-04-27T10:45:28+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "1504ae60-da9e-4028-9d8d-01fe03c2b158",
            "settlement_date": "2018-05-01T15:30:00+00:00",
            "conversion_date": "2018-05-01T00:00:00+00:00",
            "short_reference": "20180427-RPDKJW",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-27T10:49:21+00:00",
            "updated_at": "2018-04-27T10:49:21+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "271bc249-227f-4ff9-a921-0a37fafb5f9c",
            "settlement_date": "2018-05-01T15:30:00+00:00",
            "conversion_date": "2018-05-01T00:00:00+00:00",
            "short_reference": "20180427-FHJSRK",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-27T10:55:50+00:00",
            "updated_at": "2018-04-27T10:55:50+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "55900114-757a-4dcc-9b97-71732697c60e",
            "settlement_date": "2018-05-01T15:30:00+00:00",
            "conversion_date": "2018-05-01T00:00:00+00:00",
            "short_reference": "20180427-MKTVCB",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-27T10:58:01+00:00",
            "updated_at": "2018-04-27T10:58:01+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "e6008d00-5a71-4ae6-9711-f872bc6f6fd1",
            "settlement_date": "2018-05-01T15:30:00+00:00",
            "conversion_date": "2018-05-01T00:00:00+00:00",
            "short_reference": "20180427-KDPFQJ",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-27T11:00:28+00:00",
            "updated_at": "2018-04-27T11:00:28+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "54d26547-be34-4c6a-8d97-9688795cd643",
            "settlement_date": "2018-05-01T15:30:00+00:00",
            "conversion_date": "2018-05-01T00:00:00+00:00",
            "short_reference": "20180427-TRFHLV",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-27T13:04:41+00:00",
            "updated_at": "2018-04-27T13:04:41+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "8f2a3d7f-b9f8-4c95-b137-36ba70148993",
            "settlement_date": "2018-05-01T15:30:00+00:00",
            "conversion_date": "2018-05-01T00:00:00+00:00",
            "short_reference": "20180427-XGHNJB",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-27T13:57:37+00:00",
            "updated_at": "2018-04-27T13:57:38+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "5cd5c522-87a7-4e2a-87f1-056ae3ffc063",
            "settlement_date": "2018-05-01T15:30:00+00:00",
            "conversion_date": "2018-05-01T00:00:00+00:00",
            "short_reference": "20180427-ZBPJCQ",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-27T14:16:11+00:00",
            "updated_at": "2018-04-27T14:16:12+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "b1020de1-f175-4ee5-9012-ba7a7e019e9e",
            "settlement_date": "2018-05-01T15:30:00+00:00",
            "conversion_date": "2018-05-01T00:00:00+00:00",
            "short_reference": "20180427-YKSQSC",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.39",
            "fixed_side": "buy",
            "core_rate": "1.4099",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4099",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-27T15:28:12+00:00",
            "updated_at": "2018-04-27T15:28:12+00:00",
            "mid_market_rate": "1.4100"
        },
        {
            "id": "13278e3e-1501-4be0-a3d7-ff3196f0b073",
            "settlement_date": "2018-05-02T15:30:00+00:00",
            "conversion_date": "2018-05-02T00:00:00+00:00",
            "short_reference": "20180430-FYDHHN",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.54",
            "fixed_side": "buy",
            "core_rate": "1.4079",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4079",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-30T11:34:02+00:00",
            "updated_at": "2018-04-30T11:34:02+00:00",
            "mid_market_rate": "1.4080"
        },
        {
            "id": "213370c4-a7de-473e-8016-2725eb1752a6",
            "settlement_date": "2018-05-02T15:30:00+00:00",
            "conversion_date": "2018-05-02T00:00:00+00:00",
            "short_reference": "20180430-BSXTTC",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.54",
            "fixed_side": "buy",
            "core_rate": "1.4079",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4079",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-30T14:24:57+00:00",
            "updated_at": "2018-04-30T14:24:57+00:00",
            "mid_market_rate": "1.4080"
        },
        {
            "id": "552bfc23-453c-47d9-a73d-ac952d53a9f5",
            "settlement_date": "2018-05-02T15:30:00+00:00",
            "conversion_date": "2018-05-02T00:00:00+00:00",
            "short_reference": "20180430-SBXBPF",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.54",
            "fixed_side": "buy",
            "core_rate": "1.4079",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4079",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-04-30T15:01:43+00:00",
            "updated_at": "2018-04-30T15:01:43+00:00",
            "mid_market_rate": "1.4080"
        },
        {
            "id": "5eeb6627-9314-43fd-bcdf-a585a574193b",
            "settlement_date": "2018-05-03T13:00:00+00:00",
            "conversion_date": "2018-05-03T00:00:00+00:00",
            "short_reference": "20180501-WJTPFP",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "GBP",
            "sell_currency": "USD",
            "client_buy_amount": "426.11",
            "client_sell_amount": "600.00",
            "fixed_side": "sell",
            "core_rate": "1.4081",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4081",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-05-01T09:44:05+00:00",
            "updated_at": "2018-05-01T09:44:06+00:00",
            "mid_market_rate": "1.4080"
        },
        {
            "id": "6e6869ae-171d-4e91-9aaf-21e4e49ab082",
            "settlement_date": "2018-05-03T15:30:00+00:00",
            "conversion_date": "2018-05-03T00:00:00+00:00",
            "short_reference": "20180501-GWXDZT",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.54",
            "fixed_side": "buy",
            "core_rate": "1.4079",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4079",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-05-01T11:05:32+00:00",
            "updated_at": "2018-05-01T11:05:33+00:00",
            "mid_market_rate": "1.4080"
        },
        {
            "id": "f9eae605-4de6-4589-aab6-c0f1d02b4207",
            "settlement_date": "2018-05-04T15:30:00+00:00",
            "conversion_date": "2018-05-04T00:00:00+00:00",
            "short_reference": "20180502-FJKLDW",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency_pair": "GBPUSD",
            "status": "awaiting_funds",
            "buy_currency": "USD",
            "sell_currency": "GBP",
            "client_buy_amount": "150.00",
            "client_sell_amount": "106.54",
            "fixed_side": "buy",
            "core_rate": "1.4079",
            "partner_rate": "",
            "partner_status": "funds_arrived",
            "partner_buy_amount": "0.00",
            "partner_sell_amount": "0.00",
            "client_rate": "1.4079",
            "deposit_required": false,
            "deposit_amount": "0.00",
            "deposit_currency": "",
            "deposit_status": "not_required",
            "deposit_required_at": "",
            "payment_ids": [],
            "unallocated_funds": "0.00",
            "unique_request_id": null,
            "created_at": "2018-05-02T09:02:14+00:00",
            "updated_at": "2018-05-02T09:02:14+00:00",
            "mid_market_rate": "1.4080"
        }
    ],
    "pagination": {
        "total_entries": 597,
        "total_pages": 24,
        "current_page": 1,
        "per_page": 25,
        "previous_page": -1,
        "next_page": 2,
        "order": "created_at",
        "order_asc_desc": "asc"
    }
}
Error Codes
HTTP Status Code Description Params
400 on_behalf_of_self You cannot act on behalf of your own Contact
contact_not_found Contact was not found for this id
401 invalid_supplied_credentials Authentication failed with the supplied credentials
429 too_many_requests Too many requests have been made to the api. Please refer to the Developer Center for more information
500 internal_server_error Internal server error
503 service_unavailable Service is temporary unavailable
Was this page helpful?
Yes
No