customer.md

Customer

A collection of endpoints for creating and managing customers on an integration

Methods

Method	HTTP	Path	Summary
create	POST	/customer	Create Customer
deactivate_authorization	POST	/customer/authorization/deactivate	Deactivate Authorization
direct_debit_activation_charge	PUT	/customer/{id}/directdebit-activation-charge	Direct Debit Activation Charge
fetch	GET	/customer/{code}	Fetch Customer
fetch_mandate_authorizations	GET	/customer/{id}/directdebit-mandate-authorizations	Fetch Mandate Authorizations
initialize_authorization	POST	/customer/authorization/initialize	Initialize Authorization
initialize_direct_debit	POST	/customer/{id}/initialize-direct-debit	Initialize Direct Debit
list	GET	/customer	List Customers
risk_action	POST	/customer/set_risk_action	Set Risk Action
update	PUT	/customer/{code}	Update Customer
validate	POST	/customer/{code}/identification	Validate Customer
verify_authorization	GET	/customer/authorization/verify/{reference}	Verify Authorization

---

create

HTTP: POST
Path: /customer

paystack.customer.create({ ... })

Body Fields

Name	Required
email	true
first_name	false
last_name	false
phone	false
metadata	false

deactivate_authorization

HTTP: POST
Path: /customer/authorization/deactivate

paystack.customer.deactivate_authorization({ ... })

Body Fields

Name	Required
authorization_code	true

direct_debit_activation_charge

HTTP: PUT
Path: /customer/{id}/directdebit-activation-charge

paystack.customer.direct_debit_activation_charge(id, { ... })

Path Parameters

Name	Required
id	true

Body Fields

Name	Required
authorization_id	true

fetch

HTTP: GET
Path: /customer/{code}

paystack.customer.fetch(code)

Path Parameters

Name	Required
code	true

fetch_mandate_authorizations

HTTP: GET
Path: /customer/{id}/directdebit-mandate-authorizations

paystack.customer.fetch_mandate_authorizations(id)

Path Parameters

Name	Required
id	true

initialize_authorization

HTTP: POST
Path: /customer/authorization/initialize

paystack.customer.initialize_authorization({ ... })

Body Fields

Name	Required
email	true
channel	true
callback_url	false
account	false
address	false

initialize_direct_debit

HTTP: POST
Path: /customer/{id}/initialize-direct-debit

paystack.customer.initialize_direct_debit(id, { ... })

Path Parameters

Name	Required
id	true

Body Fields

Name	Required
account	true
address	true

list

HTTP: GET
Path: /customer

paystack.customer.list({ ... })

Query Fields

Name	Required
use_cursor	false
next	false
previous	false
from	false
to	false
perPage	false
page	false

risk_action

HTTP: POST
Path: /customer/set_risk_action

paystack.customer.risk_action({ ... })

Body Fields

Name	Required
customer	true
risk_action	false

update

HTTP: PUT
Path: /customer/{code}

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

Path Parameters

Name	Required
code	true

Body Fields

Name	Required
first_name	false
last_name	false
phone	false
metadata	false

validate

HTTP: POST
Path: /customer/{code}/identification

paystack.customer.validate(code, { ... })

Path Parameters

Name	Required
code	true

Body Fields

Name	Required
first_name	true
middle_name	false
last_name	true
type	true
value	false
country	true
bvn	true
bank_code	true
account_number	true

verify_authorization

HTTP: GET
Path: /customer/authorization/verify/{reference}

paystack.customer.verify_authorization(reference)

Path Parameters

Name	Required
reference	true