Skip to navigation

Get Processing Fee

View as Markdown

Retrieve the processing fee for a payment method.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Return the processing fee for a payment method, in the amount field. Pass a creditCardId to get the card processing fee. The response returns an amount of 2.0 whenever creditCardId is included, whatever card or accountId you pass, and no amount when it isn’t.

Common Failure Scenarios

  • accountId or creditCardId is included and isn’t greater than 0. This returns HTTP 400.
  • The caller’s user type, or the API key’s permissions, don’t include read access to the Users resource. This returns HTTP 401 with "Access is denied".

Error Messages

MessageResponseTrigger
"Account Id should be greater than 0"400accountId is included and isn’t greater than 0.
"Credit Card Id should be greater than 0"400creditCardId is included and isn’t greater than 0.
"Access is denied"401The caller’s user type, or the API key’s permissions, don’t include read access to the Users resource.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
accountIdlongOptional
creditCardIdlongOptional

Response

ProcessingFee
errorTextstringOptional<=8192 characters

Non-empty if the request failed

amountdoubleOptional