/v2/payments/quote_payment_fee

GET

Gets the calculated quote for the fee that will be applied against a payment

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
NameInTypeDescriptionEnum
X-Auth-Token header string Authentication token.
payment_currency query string Currency of the payment.
payment_destination_country query string Destination Country of the payment.
payment_type query string Payment Type priority
regular
Optional
NameInTypeDescriptionEnum
account_id query string Account UUID. If this is left empty, the account that makes the API call is used
charge_type query string Payment Charges type. if no value is provided the accounts default value is used ours
shared
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/payments/quote_payment_fee

Response

{
    "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
    "payment_currency": "USD",
    "payment_destination_country": "US",
    "payment_type": "regular",
    "charge_type": null,
    "fee_amount": null,
    "fee_currency": null
}
Error Codes
HTTP Status Code Description Params
400 account_id_is_not_valid_uuid account_id should be in UUID format
payment_currency_is_required payment_currency is required
payment_currency_is_in_invalid_format payment_currency is not a valid ISO 4217 currency code { "type" => "currency" }
payment_destination_country_is_required payment_destination_country is required
payment_destination_country_is_in_invalid_format payment_destination_country is in invalid format
charge_type_is_required charge_type is required
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
No