Skip to main content
POST
Add several recipients to a batch
Adds several recipients to a batch in one call. Each recipient is processed independently, and the response reports which were added successfully, keyed by account number. Requires the PAYMENT_METHOD.CREATE key permission.

Authorizations

x-api-key
string
header
required

Static business API key issued from the dashboard. A business can provision multiple API keys, each scoped to a configurable set of permissions (e.g. read transactions, create deposits, etc). Permissions are chosen per key at creation time in the dashboard and may be revoked by deleting the key. Requests made with a key that does not include the permission required by the target endpoint is rejected with a 401 Unauthorized response, the same response an unrecognised, malformed, revoked or disabled key returns. The API does not distinguish the two cases on the wire. Manage your keys and their permissions under Developer → API keys in the dashboard.

The permission each endpoint requires is below. Where several are listed, any one of them is enough. Keys created before permissions existed carry none and keep access to every endpoint.

Headers

x-api-version
string

API version in ISO 8601 format. The only supported version is 2026-05-18, which is also the default when the header is omitted. Any other value is rejected with a 400 Bad Request.

x-api-signature
string

Signature of the request payload, used for request authentication where payload signing is enabled for your business.

Path Parameters

batchId
string
required

Id of a batch belonging to the calling business.

Body

application/json
channel
string
required
Example:

"BANK_ACCOUNT"

accountName
string
required
accountNumber
string
required
countryCode
string
required
Example:

"NG"

institution
object
required

As on POST /api/v1/payment-method.

amount
object
required

Response

Per-recipient outcomes

data
object