Get fees breakdown

Calculate fees for a transaction between two currencies. Provide either from_amount or to_amount (not both). Send customer_id to get the fees that apply to that customer. Required scope: fees:read.

POSTapi-prod.blaaiz.com/api/external/fees/breakdown

Authorization

oauth2ClientCredentials fees:read

AuthorizationBearer <token>

Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.

In: header

Scope: fees:read

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

This retrieves a detailed fee breakdown for a specific transaction type between two currencies. By providing the necessary parameters, businesses can understand the applicable fees for sending or receiving funds, whether through bank transfers or other methods. This endpoint supports transactions in various currencies, allowing for flexibility and transparency in financial operations.

from_currency_id*string

Currency code you are sending from (e.g., NGN, CAD, USD)

to_currency_id*string

Currency code the recipient will receive (e.g., NGN, CAD, USD)

from_amount*number

Amount to deduct from your wallet

to_amount?number

Exact amount the recipient should receive

customer_id?string

UUID of the customer for the transaction. If the customer type is individual, the fees that target individual customers apply. If you omit this field, the standard business fees apply. If the customer does not belong to your business, the API returns a 400 error.

Formatuuid

Response Body

`application/json`

Get fees breakdown

curl --request POST \  --url 'https://example.com/api/external/fees/breakdown' \  --header 'Content-Type: application/json' \  --data '{  "from_currency_id": "NGN",  "to_currency_id": "NGN",  "from_amount": 50000}'

{  "our_fee": 1.5,  "collection_fees": [    {      "method": "CARD",      "amount": 2,      "fee": 2,      "you_send": 100,      "total_amount_to_send": 96.5,      "recipient_gets": 58000,      "our_fee": 1.5,      "total_fees": 3.5,      "amountIsRecipientGets": false,      "amountIsYouSend": true,      "rate": 600.5    },    {      "method": "OPEN_BANKING",      "amount": 0.5,      "fee": 0.5,      "you_send": 100,      "total_amount_to_send": 98,      "recipient_gets": 58900,      "our_fee": 1.5,      "total_fees": 2,      "amountIsRecipientGets": false,      "amountIsYouSend": true,      "rate": 600.5    }  ],  "payout_fees": [    {      "method": "BANK_TRANSFER",      "amount": 0,      "fee": 0,      "you_send": 100,      "total_amount_to_send": 98.5,      "recipient_gets": 59200,      "our_fee": 1.5,      "total_fees": 1.5,      "amountIsRecipientGets": false,      "amountIsYouSend": true,      "rate": 600.5    },    {      "method": "MOBILE_MONEY",      "amount": 1,      "fee": 1,      "you_send": 100,      "total_amount_to_send": 97.5,      "recipient_gets": 58600,      "our_fee": 1.5,      "total_fees": 2.5,      "amountIsRecipientGets": false,      "amountIsYouSend": true,      "rate": 600.5    }  ]}