/v2/settlements/create

POST

This endpoint is being deprecated from release 2.4.0 of our api definition as per our Deprecation Policy.


Create a new settlement. On success, returns the new settlement entity.

The Settlement model is now deprecated and only the Balance model will be supported from 31 July 2019.

See the following Cookbook for a migration guide.

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.
Optional
NameInTypeDescription
type formData string Settlement type, eg. "bulk".
on_behalf_of formData string Contact UUID.
curl -X POST  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi2.currencycloud.com/v2/settlements/create

Response

{
  "id": "bffd4c70-daf6-4d16-9828-8bb4c69f8000",
  "status": "open",
  "short_reference": "20180427-FQQQSK",
  "type": "bulk",
  "conversion_ids": [],
  "entries": [],
  "created_at": "2018-04-27T13:32:09+00:00",
  "updated_at": "2018-04-27T13:32:09+00:00",
  "released_at": ""
}
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