Skip to main content
New to Corsair? See API access, authentication, and error handling.

Customers

create

customers.create Create a customer Risk: write
Input Output

get

customers.get Read one customer by email address or code Risk: read
Input Accepts the email address or the customer code in the path. Output

list

customers.list List customers, paged and filtered by creation date Risk: read
Input Output

setRiskAction

customers.setRiskAction Whitelist, blacklist or reset a customer Risk: write
Input allow whitelists the customer, deny blacklists, default resets. Output

update

customers.update Update a customer name and contact details Risk: write
Input Output

Plans

create

plans.create Create a payment plan Risk: write
Input Output

get

plans.get Read one plan by id or code Risk: read
Input Output

list

plans.list List payment plans, filtered by interval and amount Risk: read
Input Output

update

plans.update Update a plan, optionally applying the changes to existing subscriptions Risk: write
Input update_existing_subscriptions defaults to true; pass false to leave running subscriptions untouched. Output

Refunds

create

refunds.create Refund a transaction fully or partially; money leaves the account and refunds cannot be undone Risk: destructive · Irreversible
Input Amount defaults to the full transaction amount; reference must be 8-64 characters of letters, digits, underscores or hyphens. Output

get

refunds.get Read one refund by id Risk: read
Input Output

list

refunds.list List refunds, filtered by transaction, currency and dates Risk: read
Input Output

Subscriptions

create

subscriptions.create Subscribe a customer to a plan; Paystack then debits the customer’s saved card on every interval Risk: destructive
Input Output

disable

subscriptions.disable Disable a subscription with its email token; debits stop until it is enabled again Risk: write
Input Output

enable

subscriptions.enable Enable a subscription with its email token; debits of the customer’s card resume Risk: destructive
Input Both the subscription code and the email token are required; the token is in the subscription record. Output

get

subscriptions.get Read one subscription by id or code Risk: read
Input Output

list

subscriptions.list List subscriptions, filtered by customer and plan Risk: read
Input Output

Transactions

get

transactions.get Read one transaction by id Risk: read
Input Output

initialize

transactions.initialize Start a checkout and get the authorization_url to redirect the customer to Risk: write
Input The answer carries authorization_url (redirect the customer), access_code (inline JS) and reference. Amount is in the currency subunit. Output

list

transactions.list List transactions, filtered by customer, status and dates Risk: read
Input Status filter accepts failed, success or abandoned; meta.next is an opaque cursor, not a URL; page through with page and perPage. Output

verify

transactions.verify Verify a transaction by its reference and read its final status Risk: read
Input Output