/v2/accounts/{account_id}/payment_charges_settings/{charge_settings_id}

POST

Manage given Account's Payment Charge Settings (enable, disable, set default).

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.
account_id path string Account UUID.
charge_settings_id path string Account Payment Charges Setting UUID. Can be retrieved via appropriate GET call for given Account UUID.
Optional
NameInTypeDescription
enabled formData boolean Enable or disable given Account Payment Charges Setting
default formData boolean Set given Account Payment Charges Setting as default (for the cases when 'charge_type' parameter is not specified for payment).
curl -X POST  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/accounts/{account_id}/payment_charges_settings/{charge_settings_id}

Response

{
    "charge_settings_id": "37b48141-1b0b-4c76-bcbc-8ffb4c5a98e4",
    "account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
    "charge_type": "ours",
    "enabled": false,
    "default": false
}
Error Codes
HTTP Status Code Description Params
400 id_is_not_valid_uuid id should be in UUID format
account_not_found Account was not found for this id
edit_not_allowed You are not allowed to change your 'payment_charges_settings'. In order to be enabled for additional type(s) of payment charges please contact Customer Support
banking_charges_settings_not_found Bank Charges Settings were not found for the provided ChargeSettingsId
unavailable_charge_type You are not enabled to switch on this type of charges. In order to be enabled for this option - please contact Customer Support
disable_and_default_charge_not_allowed You can not disable and then default setting.
default_disabled_charge_not_allowed You cannot default disabled setting.
disable_default_charge_not_allowed You can not disable default settings.
set_default_to_false_not_allowed You cannot disable default charge type. Please update the charge type not to be default and then disable it.
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