subaccount.md

Subaccount

A collection of endpoints for creating and managing accounts for sharing a transaction with

Methods

Method	HTTP	Path	Summary
create	POST	/subaccount	Create Subaccount
fetch	GET	/subaccount/{code}	Fetch Subaccount
list	GET	/subaccount	List Subaccounts
update	PUT	/subaccount/{code}	Update Subaccount

---

create

HTTP: POST
Path: /subaccount

paystack.subaccount.create({ ... })

Body Fields

Name	Required
business_name	true
settlement_bank	true
account_number	true
percentage_charge	true
description	false
primary_contact_email	false
primary_contact_name	false
primary_contact_phone	false
metadata	false

fetch

HTTP: GET
Path: /subaccount/{code}

paystack.subaccount.fetch(code)

Path Parameters

Name	Required
code	true

list

HTTP: GET
Path: /subaccount

paystack.subaccount.list({ ... })

Query Fields

Name	Required
perPage	false
page	false
active	false

update

HTTP: PUT
Path: /subaccount/{code}

paystack.subaccount.update(code, { ... })

Path Parameters

Name	Required
code	true

Body Fields

Name	Required
business_name	false
settlement_bank	false
account_number	false
active	false
percentage_charge	false
description	false
primary_contact_email	false
primary_contact_name	false
primary_contact_phone	false
metadata	false