Get Payment Fee Rules - Currencycloud API Documentation

Home > Get Payment Fee Rules

/v2/reference/payment_fee_rules

Get the payment fee information based on the specific values provided

The API responses shown below are static. If you want to try out the API please login, or register for an API key

Name	In	Type	Description	Enum
X-Auth-Token	header	string	Authentication token.
Optional
Name	In	Type	Description	Enum
account_id	query	string	Account UUID.
payment_type	query	string	Payment Type value. Limits search results scope to just payments of the specified payment type.	priority regular
charge_type	query	string	Payment Charges value . Limits search results scope to just payments of the specified charge type.	ours shared

curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/reference/payment_fee_rules

{
    "payment_fee_rules": []
}

HTTP Status	Code	Description	Params
400	account_id_is_not_valid_uuid	account_id should be in UUID format
	charge_type_not_in_range	charge_type should be in range: shared, ours	`{ "charge_type" => "shared, ours" }`
	payment_type_not_in_range	payment_type should be in range: priority, regular	`{ "payment_type" => "priority, regular" }`
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