transfer.md

Transfer

A collection of endpoints for automating sending money to beneficiaries

Methods

Method	HTTP	Path	Summary
bulk	POST	/transfer/bulk	Initiate Bulk Transfer
disable_otp	POST	/transfer/disable_otp	Disable OTP for Transfers
disable_otp_finalize	POST	/transfer/disable_otp_finalize	Finalize Disabling OTP for Transfers
enable_otp	POST	/transfer/enable_otp	Enable OTP requirement for Transfers
export_transfer	GET	/transfer/export	Export Transfers
fetch	GET	/transfer/{code}	Fetch Transfer
finalize	POST	/transfer/finalize_transfer	Finalize Transfer
initiate	POST	/transfer	Initiate Transfer
list	GET	/transfer	List Transfers
resend_otp	POST	/transfer/resend_otp	Resend OTP for Transfer
verify	GET	/transfer/verify/{reference}	Verify Transfer

---

bulk

HTTP: POST
Path: /transfer/bulk

paystack.transfer.bulk({ ... })

Body Fields

Name	Required
source	true
currency	false
transfers	true

disable_otp

HTTP: POST
Path: /transfer/disable_otp

paystack.transfer.disable_otp

disable_otp_finalize

HTTP: POST
Path: /transfer/disable_otp_finalize

paystack.transfer.disable_otp_finalize({ ... })

Body Fields

Name	Required
otp	true

enable_otp

HTTP: POST
Path: /transfer/enable_otp

paystack.transfer.enable_otp

export_transfer

HTTP: GET
Path: /transfer/export

paystack.transfer.export_transfer({ ... })

Query Fields

Name	Required
recipient	false
status	false
from	false
to	false

fetch

HTTP: GET
Path: /transfer/{code}

paystack.transfer.fetch(code)

Path Parameters

Name	Required
code	true

finalize

HTTP: POST
Path: /transfer/finalize_transfer

paystack.transfer.finalize({ ... })

Body Fields

Name	Required
transfer_code	true
otp	true

initiate

HTTP: POST
Path: /transfer

paystack.transfer.initiate({ ... })

list

HTTP: GET
Path: /transfer

paystack.transfer.list({ ... })

Query Fields

Name	Required
use_cursor	false
next	false
previous	false
per_page	false
page	false
from	false
to	false
recipient	false
status	false

resend_otp

HTTP: POST
Path: /transfer/resend_otp

paystack.transfer.resend_otp({ ... })

Body Fields

Name	Required
transfer_code	true
reason	true

verify

HTTP: GET
Path: /transfer/verify/{reference}

paystack.transfer.verify(reference)

Path Parameters

Name	Required
reference	true