Recipient

The Recipient class provides methods for interacting with Paystack’s Transfer Recipient API. Transfer recipients are used to define the destination for payouts and transfers.

Overview

The Recipient class allows you to:

Create single or bulk transfer recipients
List and retrieve recipient details
Update recipient information
Delete recipients

Methods

create

Creates a new transfer recipient.

async create(input: RecipientCreateInput): Promise<RecipientCreateResponse>

'nuban' | 'ghipss' | 'mobile_money'

required

The type of recipient

string

required

A name for the recipient

string

required

The recipient’s account number

string

required

The recipient’s bank code

string

A description for the recipient

'NGN' | 'USD' | 'GHS' | 'ZAR' | 'KES' | 'XOF'

Currency for the recipient (defaults to NGN)

string

Authorization code for the recipient

any

Additional metadata for the recipient

object

boolean

Whether the recipient is active

string

The unique recipient code starting with RCP_

string

The recipient’s currency

string

The recipient type (nuban, ghipss, or mobile_money)

object

string

The account number

string

The resolved account name

string

The bank code

string

The bank name

Example:

const { data, error } = await paystack.recipient.create({
  type: "nuban",
  name: "John Doe",
  account_number: "0123456789",
  bank_code: "058",
  currency: "NGN"
});

if (data) {
  console.log(data.data.recipient_code);
}

createBulk

Creates multiple transfer recipients in bulk.

async createBulk(input: RecipientBulkCreateInput): Promise<RecipientBulkCreateResponse>

array

required

Array of recipient objects, each containing the same fields as the create method

object

array

Array of successfully created recipients

array

Array of errors for recipients that failed to create

Example:

const { data, error } = await paystack.recipient.createBulk({
  batch: [
    {
      type: "nuban",
      name: "John Doe",
      account_number: "0123456789",
      bank_code: "058"
    },
    {
      type: "nuban",
      name: "Jane Smith",
      account_number: "0987654321",
      bank_code: "058"
    }
  ]
});

if (data) {
  console.log(`Created ${data.data.success.length} recipients`);
}

list

Lists transfer recipients.

async list(input: GenericInput): Promise<RecipientListResponse>

number

Number of records per page (1-100, defaults to 50)

number

Page number (defaults to 1)

string

ISO datetime to filter from

string

ISO datetime to filter to

array

Array of recipient objects

string

The domain

string

The recipient type

string

The currency

string

The recipient name

string

The unique recipient code

boolean

Whether the recipient is active

object

Pagination metadata including total, page, perPage, and pageCount

Example:

const { data, error } = await paystack.recipient.list({
  perPage: 20,
  page: 1
});

if (data) {
  console.log(`Total recipients: ${data.meta?.total}`);
}

getRecipientById

Retrieves a single transfer recipient by ID or code.

async getRecipientById(id_or_code: string): Promise<RecipientSingleResponse>

string

required

The ID or code of the recipient

object

number

The integration ID

string

The domain

string

The recipient type

string

The currency

string

The recipient name

string

The unique recipient code

string | null

The recipient description

boolean

Whether the recipient is active

string | null

The recipient email

object

Bank details including account_number, account_name, bank_code, and bank_name

Example:

const { data, error } = await paystack.recipient.getRecipientById("RCP_abc123");

if (data) {
  console.log(data.data.name);
}

update

Updates a transfer recipient.

async update(input: RecipientUpdateInput): Promise<GenericResponse>

string

required

The ID or code of the recipient to update

string

required

The new name for the recipient

string

The new email for the recipient

Example:

const { data, error } = await paystack.recipient.update({
  id_or_code: "RCP_abc123",
  name: "John Updated",
  email: "john@example.com"
});

if (data) {
  console.log(data.message);
}

delete

Deletes a transfer recipient.

async delete(id_or_code: string): Promise<GenericResponse>

string

required

The ID or code of the recipient to delete

Example:

const { data, error } = await paystack.recipient.delete("RCP_abc123");

if (data) {
  console.log(data.message);
}

Core

Modules

Overview

Methods

create

createBulk

list

getRecipientById

update

delete

​Overview

​Methods

​create

​createBulk

​list

​getRecipientById

​update

​delete

​Related Resources

Overview

Methods

create

createBulk

list

getRecipientById

update

delete

Related Resources