Release Settlement - Currencycloud API Documentation

Home > Release Settlement

/v2/settlements/{id}/release

POST

Move a settlement to “released” status. Released settlements are ready for processing.

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

Name	In	Type	Description
X-Auth-Token	header	string	Authentication token.
id	path	string	Settlement UUID.
Optional
Name	In	Type	Description
on_behalf_of	formData	string	Contact UUID.

curl -X POST  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/settlements/{id}/release

Response

{
  "id": "bffd4c70-daf6-4d16-9828-8bb4c69f8000",
  "status": "released",
  "short_reference": "20180427-FQQQSK",
  "type": "bulk",
  "conversion_ids": [
    "906212d5-ba24-4a0a-9963-5834e9de012f"
  ],
  "entries": [
    {
      "USD": {
        "receive_amount": "500.00",
        "send_amount": "0.00"
      }
    },
    {
      "GBP": {
        "receive_amount": "0.00",
        "send_amount": "354.64"
      }
    }
  ],
  "created_at": "2018-04-27T13:32:09+00:00",
  "updated_at": "2018-04-27T13:42:03+00:00",
  "released_at": "2018-04-27T13:42:03+00:00"
}

Error Codes

HTTP Status	Code	Description
400	on_behalf_of_self	You cannot act on behalf of your own Contact
400	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

/v2/settlements/{id}/release

POST

API parameters

Required

Optional

Response

Error Codes

Start your borderless payments journey today

Cookies