/v2/conversions/{id}/split_preview

GET

Get a preview of the details of each part of a split conversion specified by the provided unique conversion id {id}.

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 The UUID of the conversion to be split, the UUID is returned by a successful trade request when creating a conversion.
amount formData string The amount at which to split this conversion.
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/conversions/{id}/split_preview

Response

{
  "parent_conversion": {
    "id": "b401a1bc-ba02-4bd6-920e-8bf6fd97282b",
    "short_reference": "20180622-XCRNWB",
    "sell_amount": "70.93",
    "sell_currency": "GBP",
    "buy_amount": "100.00",
    "buy_currency": "USD",
    "settlement_date": "2018-07-02T15:30:00+00:00",
    "conversion_date": "2018-07-02T00:00:00+00:00",
    "status": "awaiting_funds"
  },
  "child_conversion": {
    "id": "13575890-f1a3-466d-81ce-f9444d2816a7",
    "short_reference": "20180622-GXWQPV",
    "sell_amount": "35.46",
    "sell_currency": "GBP",
    "buy_amount": "50.00",
    "buy_currency": "USD",
    "settlement_date": "2018-07-02T15:30:00+00:00",
    "conversion_date": "2018-07-02T00:00:00+00:00",
    "status": "awaiting_funds"
  }
}
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
403 permission_denied You do not have permission 'split_conversion' to perform this operation
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 post helpful?
Let us know if you liked the post. That’s the only way we can improve.
Yes
No