Overview
Paystack is Africa's leading payment processor – Nigeria, Ghana, SA, Kenya, Côte d'Ivoire. Cards, mobile money, bank transfers, USSD. The Automize Paystack connector covers transactions, transfers, customers, subscriptions, AVS, plans, refunds.
- Regions: Nigeria, Ghana, South Africa, Kenya, Côte d'Ivoire, Egypt.
- Plans: Pay-per-transaction. No monthly fees.
Setting up the connection
Auth type: Bearer Token.
- Paystack dashboard → Settings → API Keys & Webhooks → copy Secret Key (sk_test_ or sk_live_).
- In Automize → Settings → Connectors → Paystack. Paste key.
Find your credentials at https://dashboard.paystack.com/#/settings/developer.
Rate limits
Paystack enforces ~100 req/sec. Connector retries 429.
Data model
Payments + customers:
Customer ─┬─ Transactions ─── Refunds
├─ Subscriptions ── Plans
└─ Bank Accounts (AVS verified)
Transfers (push to bank accounts)Available operations
21 operations available. Click any row to jump to its detail.
| Operation | Category | What it does |
|---|---|---|
| Get Balance | Account | Get account balance |
| List Settlements | Account | List settlements paid to your bank account |
| List Banks | Banking & AVS | List banks supported for collections/transfers (pass country=south africa) |
| Resolve Bank Account (AVS) | Banking & AVS | Verify a bank account number; SA returns accountOpen/holderMatch/etc. |
| Create Customer | Customers | Create a customer record |
| Fetch Customer | Customers | Get customer by email or code |
| List Customers | Customers | List customers |
| Create Refund | Refunds | Refund a transaction (full or partial) |
| List Refunds | Refunds | List refunds for a transaction or across the account |
| Create Plan | Subscriptions | Create a recurring plan |
| Create Subscription | Subscriptions | Subscribe a customer to a plan |
| Disable Subscription | Subscriptions | Disable an active subscription |
| Charge Authorization | Transactions | Charge a previously authorized card (tokenised) |
| Fetch Transaction | Transactions | Get transaction details by ID |
| Initialize Transaction | Transactions | Start a payment transaction and get a checkout URL |
| List Transactions | Transactions | List transactions (filter by status, customer, date range) |
| Verify Transaction | Transactions | Verify a transaction by its reference |
| Create Transfer Recipient | Transfers | Create a transfer recipient (bank account) |
| Initiate Transfer | Transfers | Transfer funds to a recipient |
| List Transfers | Transfers | List transfers |
| Verify Transfer | Transfers | Verify a transfer by reference |
Operations
Charge Authorization
Charge a previously authorized card (tokenised)
| Parameter | Required | Type | Description |
|---|---|---|---|
Email email | No | text | |
Amount amount | No | text | |
Authorization Code authorization_code | No | text | |
Reference reference | No | text | |
Currency currency | No | text | |
Metadata metadata | No | text |
Tips
- Recurring charge using a saved card token (authorization_code).
Create Customer
Create a customer record
| Parameter | Required | Type | Description |
|---|---|---|---|
Email email | No | text | |
First Name first_name | No | text | |
Last Name last_name | No | text | |
Phone phone | No | text | |
Metadata metadata | No | text |
Create Plan
Create a recurring plan
| Parameter | Required | Type | Description |
|---|---|---|---|
Name name | No | text | |
Amount amount | No | text | |
Interval interval | No | text | |
Description description | No | text | |
Currency currency | No | text |
Create Refund
Refund a transaction (full or partial)
| Parameter | Required | Type | Description |
|---|---|---|---|
Transaction transaction | No | text | |
Amount amount | No | text | |
Currency currency | No | text | |
Customer Note customer_note | No | text | |
Merchant Note merchant_note | No | text |
Create Subscription
Subscribe a customer to a plan
| Parameter | Required | Type | Description |
|---|---|---|---|
Customer customer | No | text | |
Plan plan | No | text | |
Authorization authorization | No | text | |
Start Date start_date | No | text |
Tips
- customer + plan + start_date. Auto-charges per plan interval.
Create Transfer Recipient
Create a transfer recipient (bank account)
| Parameter | Required | Type | Description |
|---|---|---|---|
Type type | No | text | |
Name name | No | text | |
Account Number account_number | No | text | |
Bank Code bank_code | No | text | |
Currency currency | No | text | |
Description description | No | text | |
Metadata metadata | No | text |
Disable Subscription
Disable an active subscription
| Parameter | Required | Type | Description |
|---|---|---|---|
Code code | No | text | |
Token token | No | text |
Fetch Customer
Get customer by email or code
| Parameter | Required | Type | Description |
|---|---|---|---|
Email Or Code email_or_code | Yes | text |
Fetch Transaction
Get transaction details by ID
| Parameter | Required | Type | Description |
|---|---|---|---|
Id id | Yes | text |
Get Balance
Get account balance
No input parameters.
Initialize Transaction
Start a payment transaction and get a checkout URL
| Parameter | Required | Type | Description |
|---|---|---|---|
Email email | No | text | |
Amount amount | No | text | |
Currency currency | No | text | |
Reference reference | No | text | |
Callback Url callback_url | No | text | |
Channels channels | No | text | |
Metadata metadata | No | text | |
Split Code split_code | No | text | |
Subaccount subaccount | No | text |
Tips
- email + amount (in kobo/cents). Returns authorization_url to redirect customer.
Initiate Transfer
Transfer funds to a recipient
| Parameter | Required | Type | Description |
|---|---|---|---|
Source source | No | text | |
Amount amount | No | text | |
Recipient recipient | No | text | |
Reason reason | No | text | |
Currency currency | No | text | |
Reference reference | No | text |
List Banks
List banks supported for collections/transfers (pass country=south africa)
No input parameters.
List Customers
List customers
No input parameters.
Tips
- Filter by email, perPage, page.
List Refunds
List refunds for a transaction or across the account
No input parameters.
List Settlements
List settlements paid to your bank account
No input parameters.
List Transactions
List transactions (filter by status, customer, date range)
No input parameters.
List Transfers
List transfers
No input parameters.
Resolve Bank Account (AVS)
Verify a bank account number; SA returns accountOpen/holderMatch/etc.
No input parameters.
Verify Transaction
Verify a transaction by its reference
| Parameter | Required | Type | Description |
|---|---|---|---|
Reference reference | Yes | text |
Tips
- reference. Returns success status + paid amount + customer.
Verify Transfer
Verify a transfer by reference
| Parameter | Required | Type | Description |
|---|---|---|---|
Reference reference | Yes | text |
FAQ
- Test vs live keys?
- sk_test_ for sandbox; sk_live_ for production. Use separate connections per environment.
- Why is my transfer requiring OTP?
- Outgoing transfers in NG require OTP for security. The Finalize Transfer step takes the OTP. Configure your business to skip OTP via Paystack support if appropriate.