/v2/reference/payment_dates

GET

Get a list of invalid payment dates for a given currency. A payment date is when a payment will be executed by Currencycloud. Payments cannot be made on some days, for example when banks are closed.

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
NameInTypeDescriptionFormat
X-Auth-Token header string Authentication token.
currency query string Currency in which payment made. Three-digit currency code.
Optional
NameInTypeDescriptionFormat
start_date query string Payment start date. ISO 8601 format YYYY-MM-DD. date
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/reference/payment_dates

Response

{
    "invalid_payment_dates": {
        "2018-08-11": "No trading on Saturday",
        "2018-08-12": "No trading on Sunday",
        "2018-08-18": "No trading on Saturday",
        "2018-08-19": "No trading on Sunday",
        "2018-08-25": "No trading on Saturday",
        "2018-08-26": "No trading on Sunday",
        "2018-08-27": "",
        "2018-09-01": "No trading on Saturday",
        "2018-09-02": "No trading on Sunday",
        "2018-09-08": "No trading on Saturday",
        "2018-09-09": "No trading on Sunday",
        "2018-09-15": "No trading on Saturday",
        "2018-09-16": "No trading on Sunday",
        "2018-09-22": "No trading on Saturday",
        "2018-09-23": "No trading on Sunday",
        "2018-09-29": "No trading on Saturday",
        "2018-09-30": "No trading on Sunday",
        "2018-10-06": "No trading on Saturday",
        "2018-10-07": "No trading on Sunday"
    },
    "first_payment_date": "2018-08-13"
}
Error Codes
HTTP Status Code Description Params
400 currency_is_required currency is required
invalid_currency The currency specified was invalid
currency_is_too_short currency can not be shorter than 3 character(s) { "minlength" => 3 }
currency_is_too_long currency can not be longer than 3 character(s) { "maxlength" => 3 }
start_date_is_too_far_in_future Date is too far in the future (more than 1 year) { "maxdate" => "2015-04-04T00:00:00Z", "period" => "1 year" }
start_date_is_in_invalid_format Date is too far in the future (more than 1 year) { "type" => "date" }
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