Gets Payment Delivery Date.

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

X-Auth-Token header string Authentication token.
payment_date query string The date when the payment will be released. Any valid ISO 8601 format, eg. "2020-12-31".
payment_type query string Currencycloud supports two types of payments: "priority", made using the SWIFT network; and "regular", made using the local bank network. priority
currency query string The 3-letter ISO code of the currency of the payment
bank_country query string The 2-letter ISO code of the country where the payment is sent
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/payments/payment_delivery_date


    "payment_date": "2022-02-03",
    "payment_delivery_date": "2022-02-03T00:00:00+00:00",
    "payment_cutoff_time": "2022-02-03T23:59:00+00:00",
    "payment_type": "regular",
    "currency": "GBP",
    "bank_country": "GB"
Error Codes
HTTP Status Code Description Params
400 bank_country_is_required bank_country is required
bank_country_is_in_invalid_format bank_country is in invalid format
currency_is_required currency is required
currency_is_in_invalid_format Currency is not a valid ISO 4217 currency code
payment_type_is_required payment_type is required
payment_type_not_in_range payment_type should be in range: priority, regular { "range" => "priority, regular" }
invalid_payment Payment cannot be processed
invalid_currency You cannot make payments with this currency
payment_date_is_required payment_date is required
invalid_payment_date The payment date is invalid
payment_date_is_in_invalid_format payment_date should be in ISO 8601 format
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 post helpful?
Let us know if you liked the post. That’s the only way we can improve.