Preview fees for a batch of transfers 🔒

curl --request POST \
  --url https://api-staging.usenumero.com/numeroaccount/api/v1/business/fee/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-Numero-Api-Key: <api-key>' \
  --header 'X-Numero-Signature: <api-key>' \
  --data '
{
  "transferItems": [
    {
      "amount": 123
    }
  ]
}
'

{
  "status": true,
  "message": "Successful",
  "code": "200",
  "version": "v1",
  "reference": "abc123",
  "data": {
    "totalAmount": 350000,
    "totalNumeroFee": 30,
    "totalStampDuty": 100,
    "totalFee": 130,
    "totalDeductible": 350130,
    "feeBreakdown": [
      {
        "amount": 150000,
        "numeroFee": 15,
        "stampDuty": 50,
        "totalFee": 65
      },
      {
        "amount": 200000,
        "numeroFee": 15,
        "stampDuty": 50,
        "totalFee": 65
      }
    ]
  },
  "error": null
}

POST

business

fee

bulk

Preview fees for a batch of transfers 🔒

curl --request POST \
  --url https://api-staging.usenumero.com/numeroaccount/api/v1/business/fee/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-Numero-Api-Key: <api-key>' \
  --header 'X-Numero-Signature: <api-key>' \
  --data '
{
  "transferItems": [
    {
      "amount": 123
    }
  ]
}
'

{
  "status": true,
  "message": "Successful",
  "code": "200",
  "version": "v1",
  "reference": "abc123",
  "data": {
    "totalAmount": 350000,
    "totalNumeroFee": 30,
    "totalStampDuty": 100,
    "totalFee": 130,
    "totalDeductible": 350130,
    "feeBreakdown": [
      {
        "amount": 150000,
        "numeroFee": 15,
        "stampDuty": 50,
        "totalFee": 65
      },
      {
        "amount": 200000,
        "numeroFee": 15,
        "stampDuty": 50,
        "totalFee": 65
      }
    ]
  },
  "error": null
}

Authorizations

X-Numero-Api-Key

string

header

required

Your business API key (live_key_...). Issued on approval; managed in Dashboard → Settings → Developer.

X-Numero-Signature

string

header

required

Base64(HMAC-SHA256(secretApiKey, input)) over the raw request body (POST) or canonicalized query string (signed GET). Also send X-Numero-Signature-Version: v2. Required on money-movement / state-changing endpoints (marked 🔒).

Body

application/json

transferItems

object[]

required

Show child attributes

Response

Successful response

Canonical response envelope for the public surface. data on success, error on failure.

data

any

required

Endpoint payload on success (object or array); null on failure.

error

object

required

Show child attributes