Skip to main content
POST
/
business
/
bulk
Initiate a bulk transfer 🔒
curl --request POST \
  --url https://api-staging.usenumero.com/numeroaccount/api/v1/business/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-Numero-Api-Key: <api-key>' \
  --header 'X-Numero-Signature: <api-key>' \
  --data '
{
  "transferRequest": [
    {}
  ],
  "transferSessionId": "<string>",
  "validationCode": "<string>",
  "transactionPin": "<string>",
  "phoneNumber": "<string>"
}
'
{ "status": true, "message": "Successful", "code": "200", "version": "v1", "reference": "abc123", "data": { "transferReference": [ "TRF-20240115-abc123", "TRF-20240115-def456" ] }, "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
transferRequest
object[]
required
transferSessionId
string | null
validationCode
string | null
transactionPin
string | null
phoneNumber
string | null

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
meta
object
required