Quote transaction fees

GET

fees

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "amount": 400,
    "providerFee": 6,
    "platformFee": 1.5,
    "merchantFee": 0,
    "totalFees": 7.5,
    "chargedAmount": 407.5,
    "netAmount": 400
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

Authorizations

Authorization

string

header

required

Secret API key. Use sk_test_... for sandbox data or sk_live_... for live data (after verification and live mode). Do not use pk_ keys.

Query Parameters

amount

number

required

Business amount in naira (escrow hold, wallet top-up, or payout). For type=deposit, the gross inbound transfer amount.

Example:

400

type

enum<string>

required

collection = checkout / card funding. transfer = customer or merchant payout. deposit = inbound dedicated NUBAN transfer (provider deposit fee deducted from gross).

Available options:

collection,

transfer,

deposit

Example:

"collection"

merchantFee

number

Optional merchant surcharge in naira. Defaults to 0.

Example:

0

Response

Request succeeded

success

boolean

Example:

true

data

object

Show child attributes

meta

object

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "amount": 400,
    "providerFee": 6,
    "platformFee": 1.5,
    "merchantFee": 0,
    "totalFees": 7.5,
    "chargedAmount": 407.5,
    "netAmount": 400
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request",
    "details": {}
  },
  "meta": {
    "requestId": "req_01hxyz"
  }
}

customers

escrows

checkout

transactions

wallets

payouts

fees

identity

Authorizations

Query Parameters

Response