/v2/conversions/{id}/date_change

POST

Changes the date ofthe conversion identified by the provided unique 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 ID of the conversion that is being changed
new_settlement_date formData string New conversion settlement date
Optional
NameInTypeDescription
on_behalf_of formData string Contact UUID.
curl -X POST  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/conversions/{id}/date_change

Response

{
    "conversion_id": "1d98fa3d-e27b-459f-890e-069974cded61",
    "amount": "-0.01",
    "currency": "GBP",
    "new_conversion_date": "2018-08-13T00:00:00+00:00",
    "new_settlement_date": "2018-08-13T15:30:00+00:00",
    "old_conversion_date": "2018-08-14T00:00:00+00:00",
    "old_settlement_date": "2018-08-14T15:30:00+00:00",
    "event_date_time": "2018-08-10T18:15:51+00:00"
}
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
invalid_extra_parameters Invalid extra parameters extra_parameter { "parameters" => "extra_parameter" }
new_settlement_date_invalid_in_past New settlement date has to be today or greater than today's date
new_settlement_date_invalid Invalid new settlement date, next valid date time is - YYYY-MM-DDT15:30:00Z
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