transfer_recipient.md

TransferRecipient

A collection of endpoints for creating and managing beneficiaries that you send money to

Methods

Method	HTTP	Path	Summary
transferrecipient_bulk	POST	/transferrecipient/bulk	Bulk Create Transfer Recipient
transferrecipient_create	POST	/transferrecipient	Create Transfer Recipient
transferrecipient_delete	DELETE	/transferrecipient/{code}	Delete Transfer Recipient
transferrecipient_fetch	GET	/transferrecipient/{code}	Fetch Transfer recipient
transferrecipient_list	GET	/transferrecipient	List Transfer Recipients
transferrecipient_update	PUT	/transferrecipient/{code}	Update Transfer Recipient

---

transferrecipient_bulk

HTTP: POST
Path: /transferrecipient/bulk

paystack.transfer_recipient.transferrecipient_bulk({ ... })

Body Fields

Name	Required
batch	true

transferrecipient_create

HTTP: POST
Path: /transferrecipient

paystack.transfer_recipient.transferrecipient_create({ ... })

Body Fields

Name	Required
type	true
name	true
account_number	true
bank_code	true
description	false
currency	false
authorization_code	false
metadata	false

transferrecipient_delete

HTTP: DELETE
Path: /transferrecipient/{code}

paystack.transfer_recipient.transferrecipient_delete(code)

Path Parameters

Name	Required
code	true

transferrecipient_fetch

HTTP: GET
Path: /transferrecipient/{code}

paystack.transfer_recipient.transferrecipient_fetch(code)

Path Parameters

Name	Required
code	true

transferrecipient_list

HTTP: GET
Path: /transferrecipient

paystack.transfer_recipient.transferrecipient_list({ ... })

Query Fields

Name	Required
use_cursor	false
next	false
previous	false
per_page	false
page	false

transferrecipient_update

HTTP: PUT
Path: /transferrecipient/{code}

paystack.transfer_recipient.transferrecipient_update(code, { ... })

Path Parameters

Name	Required
code	true

Body Fields

Name	Required
name	false
email	false