← Tools Reference

Paystack

Paystack integration (Finance). Imported from open-connector.

API key8 toolshttps://api.paystack.co
POST
paystack_create_customer
Create a customer in Paystack.

/customer

5 parameters
ParamTypeRequiredDescription
emailstringrequiredCustomer email address.
first_namestringoptionalCustomer first name.
last_namestringoptionalCustomer last name.
phonestringoptionalCustomer phone number.
metadataobjectoptionalMetadata object sent to or returned by Paystack.
GET
paystack_list_customers
List customers available in Paystack.

/customer

4 parameters
ParamTypeRequiredDescription
pageintegeroptionalPage number to fetch.
perPageintegeroptionalNumber of records to return per page.
fromstringoptionalInclusive ISO 8601 start timestamp used to filter creation time.
tostringoptionalInclusive ISO 8601 end timestamp used to filter creation time.
GET
paystack_get_customer
Fetch a customer in Paystack by email address or customer code.

/customer/{email_or_code}

1 parameter
ParamTypeRequiredDescription
email_or_codestringrequiredCustomer email address or customer code accepted by Paystack.
PUT
paystack_update_customer
Update a Paystack customer by customer code.

/customer/{code}

6 parameters
ParamTypeRequiredDescription
codestringrequiredCustomer code used in the Paystack update path.
emailstringrequiredCustomer email address.
first_namestringoptionalCustomer first name.
last_namestringoptionalCustomer last name.
phonestringoptionalCustomer phone number.
metadataobjectoptionalMetadata object sent to or returned by Paystack.
POST
paystack_initialize_transaction
Initialize a Paystack transaction and return checkout details.

/transaction/initialize

6 parameters
ParamTypeRequiredDescription
emailstringrequiredCustomer email address used for the transaction.
amountintegerrequiredTransaction amount in the smallest currency unit.
currencystringoptionalTransaction currency code.
referencestringoptionalCustom transaction reference.
callback_urlstringoptionalCallback URL used after checkout completes.
metadataobjectoptionalMetadata object sent to or returned by Paystack.
GET
paystack_list_transactions
List transactions available in Paystack.

/transaction

6 parameters
ParamTypeRequiredDescription
pageintegeroptionalPage number to fetch.
perPageintegeroptionalNumber of records to return per page.
fromstringoptionalInclusive ISO 8601 start timestamp used to filter creation time.
tostringoptionalInclusive ISO 8601 end timestamp used to filter creation time.
statusstringoptionalTransaction status filter.
customerstringoptionalCustomer code filter.
GET
paystack_get_transaction
Fetch a Paystack transaction by transaction ID.

/transaction/{id}

1 parameter
ParamTypeRequiredDescription
idintegerrequiredPaystack transaction ID.
GET
paystack_verify_transaction
Verify a Paystack transaction by reference.

/transaction/verify/{reference}

1 parameter
ParamTypeRequiredDescription
referencestringrequiredTransaction reference used by Paystack verify.