Get Payment Charges Settings - Currencycloud API Documentation

Home > Get Payment Charges Settings

/v2/accounts/{account_id}/payment_charges_settings

GET

Retrieve payment charges settings for given account.

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.
account_id	path	string	An UUID of a sub-account or house account available in current visibility scope.

curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/accounts/{account_id}/payment_charges_settings

Response

{
    "payment_charges_settings": [
        {
            "charge_settings_id": "37b48141-1b0b-4c76-bcbc-8ffb4c5a98e4",
            "account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "charge_type": "ours",
            "enabled": false,
            "default": false
        },
        {
            "charge_settings_id": "e43db1d1-2d48-4ed1-90ca-542ec45bcbe8",
            "account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "charge_type": "shared",
            "enabled": true,
            "default": true
        }
    ]
}

Error Codes

HTTP Status	Code	Description
400	id_is_not_valid_uuid	id should be in UUID format
400	account_not_found	Account 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/accounts/{account_id}/payment_charges_settings

GET

API parameters

Required

Response

Error Codes

Start your borderless payments journey today

Cookies