AFafriex
Payment Batches

Update a recipient in a batch

Replaces the recipient's account details and amount. Pass paymentMethodId to update that saved account in place. A recipientId that is not in this batch is refused with 400, not 404. Requires the PAYMENT_BATCH.UPDATE key permission.

patch/api/v1/payment-batch/{batchId}/recipients/{recipientId}

Request

Request body

paymentMethodIdstring

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.

channel'BANK_ACCOUNT' | 'MOBILE_MONEY' | 'VIRTUAL_BANK_ACCOUNT' | 'ACH_BANK_ACCOUNT' | 'INTERAC' | 'UPI' | 'SWIFT' | 'WE_CHAT' required
accountNamestring

Not used for VIRTUAL_BANK_ACCOUNT.

accountNumberstring

Not used for VIRTUAL_BANK_ACCOUNT.

countryCodestring required
institutionobject

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

Example request

{
  "channel": "BANK_ACCOUNT",
  "countryCode": "NG",
  "amount": {
    "value": "15000",
    "currencyCode": "NGN"
  }
}

Response

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

Changes

No recorded changes to this operation across all 1 revision of this API.