Skip to main content
PATCH
Update a recipient in a batch
Omit paymentMethodId to leave the account alone and change only the amount.

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.

recipientId
string
required

The recipientId returned by the recipient list.

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. accountName, accountNumber and institution are required for most channels: institution is not used for UPI and INTERAC, and accountName and accountNumber are not used for VIRTUAL_BANK_ACCOUNT. paymentMethodId updates an existing saved account of this business in place instead of creating one.

channel
enum<string>
required
Available options:
BANK_ACCOUNT,
MOBILE_MONEY,
VIRTUAL_BANK_ACCOUNT,
ACH_BANK_ACCOUNT,
INTERAC,
UPI,
SWIFT,
WE_CHAT
Example:

"BANK_ACCOUNT"

countryCode
string
required
Example:

"NG"

amount
object
required
paymentMethodId
string

Id of a saved account of this business to update with these details. An id that is not one of this business's accounts is refused with 400.

accountName
string

Not used for VIRTUAL_BANK_ACCOUNT.

accountNumber
string

Not used for VIRTUAL_BANK_ACCOUNT.

institution
object

As on POST /api/v1/payment-method. Not used for UPI and INTERAC.

Response

The saved account. The full recipient shape comes from the recipient list.

data
object

What creating or updating a recipient returns: the saved account only. The full recipient shape, with the amount and recipientId, comes from the recipient list.