Skip to main content
POST
Add one recipient to a batch
Adds a single recipient to a batch. For adding many at once, use bulk add recipients. 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. Manage your keys and their permissions under Developer → API keys in the dashboard.

A request whose key does not carry the permission the target endpoint requires is rejected with 401 Unauthorized, the same response an unrecognised, malformed, revoked or disabled key returns. The API does not distinguish the two cases on the wire.

See the Permissions reference for the permission each endpoint requires.

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

The account to pay, in the same shape POST /api/v1/payment-method accepts, plus the amount to pay it in this batch.

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

The created recipient

data
object

One payout in a batch. The response includes the channel, country, institution, account name and number, the per-run amount, and the batch and recipient ids. Fields not listed on this schema are not returned.