Skip to main content
POST
Quote a Fee for an Amount

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Quote one fee line for an amount on the public platform API.

The platform is taken from your credentials — you supply only the line and the amount. The quote runs the same engine real charges use, so it reflects your active override when one is set, otherwise the global default.

fee_code
string
required

The fee line to price, e.g. ach.push or card.acquiring.

Required string length: 1 - 80
Example:

"card.acquiring"

amount
number
required

The payment amount (major units) to price the fee against.

Example:

100

currency
string
default:USD

ISO 4217 currency code.

Required string length: 3
Example:

"USD"

Response

The resolved fee for the amount, with the payer / payee breakdown.

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.