/v2/conversions/{id}

GET

Get a conversion record.

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
NameInTypeDescription
X-Auth-Token header string Authentication token.
id path string Conversion UUID.
Optional
NameInTypeDescription
on_behalf_of query string Contact UUID.
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/conversions/{id}

Response

{
    "id": "1d98fa3d-e27b-459f-890e-069974cded61",
    "settlement_date": "2018-08-14T15:30:00+00:00",
    "conversion_date": "2018-08-14T00:00:00+00:00",
    "short_reference": "20180810-YCVNGM",
    "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": "150.00",
    "unique_request_id": null,
    "created_at": "2018-08-10T18:15:49+00:00",
    "updated_at": "2018-08-10T18:15:49+00:00",
    "mid_market_rate": "1.4100"
}
Error Codes
HTTP Status Code Description Params
400 id_is_not_valid_uuid id should be in UUID format
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