/v2/settlements/find

GET

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


Get a list of settlements based on search criteria.

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
NameInTypeDescriptionEnumDefault
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescriptionEnumDefault
on_behalf_of query string Contact UUID.
short_reference query string Short reference code.
status query string Settlement status, as shown to sub-account contacts. open
released
funds_arrived
part_paid
paid
created_at_from query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
created_at_to query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
updated_at_from query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
updated_at_to query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
released_at_from query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
released_at_to query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00".
page query integer Page number.
per_page query integer Number of results per page.
order query string Any field name to change the sort order.
order_asc_desc query string Sort records in ascending or descending order. asc
desc
asc
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/settlements/find

Response

{
  "settlements": [
    {
      "id": "bffd4c70-daf6-4d16-9828-8bb4c69f8000",
      "status": "open",
      "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:32:09+00:00",
      "released_at": ""
    }
  ],
  "pagination": {
    "total_entries": 1,
    "total_pages": 1,
    "current_page": 1,
    "per_page": 25,
    "previous_page": -1,
    "next_page": -1,
    "order": "created_at",
    "order_asc_desc": "asc"
  }
}
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