Paystack

Unregister a top-level domain or subdomain previously used for your Apple Pay integration. via DELETE /apple-pay/domain

Deactivate a dedicated virtual account on your integration. via DELETE /dedicated_account/{id}

If you've previously set up split payment for transactions on a dedicated virtual account, you can remove it with this endpoint via DELETE /dedicated_account/split

Delete a previously created product via DELETE /product/{id}

Delete a previously created Storefront via DELETE /storefront/{id}

Delete a transfer recipient (sets the transfer recipient to inactive) via DELETE /transferrecipient/{code}

Remove Split Code from Virtual Terminal via DELETE /virtual_terminal/{code}/split_code

Get a list of states for a country for address verification via GET /address_verification/states

Lists all registered domains on your integration. Returns an empty array if no domains have been added. via GET /apple-pay/domain

Fetch the available balance on your integration via GET /balance

Fetch all pay-ins and pay-outs that occured on your integration via GET /balance/ledger

List banks supported on Paystack via GET /bank

Resolve an account number to confirm the name associated with it via GET /bank/resolve

List all bulk charge batches. via GET /bulkcharge

This endpoint retrieves a specific batch code. It also returns useful information on its progress by way of the `total_charges` and `pending_charges` attributes. via GET /bulkcharge/{code}

This endpoint retrieves the charges associated with a specified batch code via GET /bulkcharge/{code}/charges

Pause the processing of a charge batch via GET /bulkcharge/pause/{code}

Resume the processing of a previously paused charge batch via GET /bulkcharge/resume/{code}

When you get `pending` as a charge status or if there was an exception when calling any of the `/charge` endpoints, wait 10 seconds or more, then make a check to see if its status has changed. Don't call too early as you may get a lot more pending than you should. via GET /charge/{reference}

List all supported countries on Paystack via GET /country

List customers on your integration via GET /customer

Check the status of an authorization request via GET /customer/authorization/verify/{reference}

Get details of a customer on your integration. via GET /customer/{code}

Get the list of direct debit mandates associated with a customer via GET /customer/{id}/directdebit-mandate-authorizations

Get the details of a card BIN via GET /decision/bin/{bin}

List dedicated virtual accounts available on your integration. via GET /dedicated_account

Get available bank providers for a dedicated virtual account via GET /dedicated_account/available_providers

Get details of a dedicated virtual account on your integration. via GET /dedicated_account/{id}

Requery Dedicated Virtual Account for new transactions via GET /dedicated_account/requery

Get a list of all the direct debit mandates on your integration via GET /directdebit/mandate-authorizations

List transaction disputes filed by customers via GET /dispute

Fetch a transaction dispute via GET /dispute/{id}

Get the URL to upload a dispute evidence via GET /dispute/{id}/upload_url

Export the disputes available on your integration via GET /dispute/export

List all disputes filed for a transaction via GET /dispute/transaction/{id}

Fetch the session timeout of a transaction via GET /integration/payment_session_timeout

List the previously created orders via GET /order

Validate a pay for me order via GET /order/{code}/validate

Fetch the details of a previously created order via GET /order/{id}

Fetch all orders for a particular product via GET /order/product/{id}

List all previously created payment pages via GET /page

Get a previously created payment page via GET /page/{id}

Check if a custom slug is available for use when creating a payment page via GET /page/check_slug_availability/{slug}

List all previously created payment requests to your customers via GET /paymentrequest

Fetch a previously created payment request via GET /paymentrequest/{id}

Get the metric of all pending and successful payment requests via GET /paymentrequest/totals

Verify the status of a previously created payment request via GET /paymentrequest/verify/{id}

List all recurring payment plans via GET /plan

Get the details of a payment plan via GET /plan/{code}

List all previously created products via GET /product

Fetch a previously created product via GET /product/{id}

List previously created refunds via GET /refund

Get a previously created refund via GET /refund/{id}

List settlements made to your settlement accounts via GET /settlement

Get the transactions that make up a particular settlement via GET /settlement/{id}/transactions

List the transaction splits available on your integration via GET /split

Get details of a split configuration for a transaction via GET /split/{id}

List the storefronts you previously created via GET /storefront

Get the details of a previously created Storefront via GET /storefront/{id}

Fetch all orders in your Storefront via GET /storefront/{id}/order

List the products in a Storefront via GET /storefront/{id}/product

Verify the availability of a slug before using it for your Storefront via GET /storefront/verify/{slug}

List subaccounts available on your integration via GET /subaccount

Get details of a subaccount on your integration via GET /subaccount/{code}

List all subscriptions available on your integration via GET /subscription

Get details of a customer's subscription via GET /subscription/{code}

Generate a link for updating the card on a subscription via GET /subscription/{code}/manage/link

List the Terminals available on your integration via GET /terminal

Get the details of a Terminal via GET /terminal/{terminal_id}

Check the status of an event sent to the Terminal via GET /terminal/{terminal_id}/event/{event_id}

Check the availiability of a Terminal before sending an event to it via GET /terminal/{terminal_id}/presence

List transactions that has occurred on your integration via GET /transaction

Fetch a transaction to get its details via GET /transaction/{id}

Download transactions that occurred on your integration for a specific timeframe via GET /transaction/export

Fetch the steps taken from the initiation to the completion of a transaction via GET /transaction/timeline/{id}

Get the total amount of all transactions via GET /transaction/totals

Verify a previously initiated transaction using it's reference via GET /transaction/verify/{reference}

List the transfers made on your integration via GET /transfer

Get details of a transfer on your integration via GET /transfer/{code}

Export a list of transfers carried out on your integration via GET /transfer/export

Verify the status of a transfer on your integration via GET /transfer/verify/{reference}

List transfer recipients available on your integration via GET /transferrecipient

Fetch the details of a transfer recipient via GET /transferrecipient/{code}

List Virtual Terminals on your integration via GET /virtual_terminal

Fetch a Virtual Terminal on your integration via GET /virtual_terminal/{code}

Register a top-level domain or subdomain for your Apple Pay integration. > This endpoint can only be called with one domain or subdomain at a time. via POST /apple-pay/domain

Confirm the authenticity of a customer's account number before sending money via POST /bank/validate

Charge multiple customers in batches via POST /bulkcharge

Initiate a payment by integrating the payment channel of your choice. via POST /charge

Send the details of the customer's address for address verification via POST /charge/submit_address

Submit the customer's birthday when requested via POST /charge/submit_birthday

Submit OTP to complete a charge via POST /charge/submit_otp

Submit phone number when requested via POST /charge/submit_phone

Submit PIN to continue a charge via POST /charge/submit_pin

Create a customer on your integration via POST /customer

Deactivate an authorization for any payment channel. via POST /customer/authorization/deactivate

Initiate a request to create a reusable authorization code for recurring transactions via POST /customer/authorization/initialize

Validate a customer's identity via POST /customer/{code}/identification

Initialize the process of linking an account to a customer for Direct Debit transactions via POST /customer/{id}/initialize-direct-debit

Set customer's risk action by whitelisting or blacklisting the customer via POST /customer/set_risk_action

Create a dedicated virtual account for an existing customer via POST /dedicated_account

With this endpoint, you can create a customer, validate the customer, and assign a DVA to the customer. via POST /dedicated_account/assign

Split a dedicated virtual account transaction with one or more accounts via POST /dedicated_account/split

Provide evidence for a dispute via POST /dispute/{id}/evidence

Create an order for selected items via POST /order

Create a webpage to receive payments via POST /page

Add products to a previously created payment page. You can only add products to pages that was created with a `product` type. via POST /page/{id}/product

Create a new payment request by issuing an invoice to a customer via POST /paymentrequest

Archive a payment request to clean up your records. An archived payment request cannot be verified and will not be returned when listing all previously created payment requests. via POST /paymentrequest/archive/{id}

Finalise the creation of a draft payment request for a customer via POST /paymentrequest/finalize/{id}

Trigger an email reminder to a customer for a previously created payment request via POST /paymentrequest/notify/{id}

Create a plan for recurring payments via POST /plan

Create a new product on your integration via POST /product

Initiate a refund for a previously completed transaction via POST /refund

Retry a refund with a `needs-attention` status by providing the bank account details of a customer. via POST /refund/retry_with_customer_details/{id}

Create a split configuration for transactions via POST /split

Add a subaccount to a split configuration, or update the share of an existing subaccount via POST /split/{id}/subaccount/add

Remove a subaccount from a split configuration via POST /split/{id}/subaccount/remove

Create a digital shop to manage and display your products via POST /storefront

Duplicate a previously created Storefront via POST /storefront/{id}/duplicate

Add previously created products to a Storefront via POST /storefront/{id}/product

Make your Storefront publicly available via POST /storefront/{id}/publish

Create a subacount for a partner via POST /subaccount

Create a subscription a customer via POST /subscription

Email a customer a link for updating the card on their subscription via POST /subscription/{code}/manage/email

Disable a subscription on your integration via POST /subscription/disable

Enable a subscription on your integration via POST /subscription/enable

Send an event from your application to the Paystack Terminal via POST /terminal/{id}/event

Activate your debug device by linking it to your integration via POST /terminal/commission_device

Unlink your debug device from your integration via POST /terminal/decommission_device

Charge all authorizations marked as reusable with this endpoint whenever you need to receive payments via POST /transaction/charge_authorization

Create a new transaction via POST /transaction/initialize

Retrieve part of a payment from a customer via POST /transaction/partial_debit

Send money to your customers via POST /transfer

Batch multiple transfers in a single request. You need to disable the Transfers OTP requirement to use this endpoint. via POST /transfer/bulk

This is used in the event that you want to be able to complete transfers programmatically without use of OTPs. No arguments required. You will get an OTP to complete the request. via POST /transfer/disable_otp

Finalize the request to disable OTP on your transfers via POST /transfer/disable_otp_finalize

In the event that a customer wants to stop being able to complete transfers programmatically, this endpoint helps turn OTP requirement back on. No arguments required. via POST /transfer/enable_otp

Finalize an initiated transfer via POST /transfer/finalize_transfer

Generates and send a new OTP to customer in the event they are having trouble receiving one. via POST /transfer/resend_otp

Creates a new recipient. A duplicate account number will lead to the retrieval of the existing record. via POST /transferrecipient

Create multiple transfer recipients in batches. A duplicate account number will lead to the retrieval of the existing record. via POST /transferrecipient/bulk

Create a Virtual Terminal on your integration via POST /virtual_terminal

Add a destination (WhatsApp number) to a Virtual Terminal on your integration via POST /virtual_terminal/{code}/destination/assign

Unassign a destination (WhatsApp Number) from a Virtual Terminal on your integration via POST /virtual_terminal/{code}/destination/unassign

Update a customer's details on your integration via PUT /customer/{code}

Trigger an activation charge on an inactive mandate on behalf of your customer via PUT /customer/{id}/directdebit-activation-charge

Trigger activation charge for specified customers via PUT /directdebit/activation-charge

Update a transaction dispute via PUT /dispute/{id}

Resolve a transaction dispute via PUT /dispute/{id}/resolve

Update the session timeout of a transaction via PUT /integration/payment_session_timeout

Update a previously created payment page via PUT /page/{id}

Update a previously created payment request via PUT /paymentrequest/{id}

Update a plan details on your integration via PUT /plan/{code}

Update a previously created product via PUT /product/{id}

Update a split configuration for transactions via PUT /split/{id}

Update the details of a previously created Storefront via PUT /storefront/{id}

Update a subaccount details on your integration via PUT /subaccount/{code}

Update the details of a Terminal via PUT /terminal/{terminal_id}

Update the details of a transfer recipient via PUT /transferrecipient/{code}

Update a Virtual Terminal on your integration via PUT /virtual_terminal/{code}

Deactivate a Virtual Terminal on your integration via PUT /virtual_terminal/{code}/deactivate

Add Split Code to Virtual Terminal via PUT /virtual_terminal/{code}/split_code