Paystack transfer api Bulk Transfer API. If you need to directly debit your customer in future, specify recurring=true in the custom_filters object to ensure we accept only Verve cards that support recurring billing and force a bank authentication for MasterCard and This tutorial teaches you how to integrate paystack single transfer fund api payment integration in php. 6, last published: 4 years ago. At the end of this guide, you'll have set up a Paystack Collection and made your first test payment on At this point, we mark the transfer as failed and send the transfer. Past Incidents. The Paystack API gives you access to pretty much all the features you can use on our dashboard and lets you extend them for use in your application. NGN 25 per Transfer. Explore all demos or start with the most popular ones below. Transfers Control. Introduction Takes the settings for the Pay with Transfer (PwT) channel. The Products API allows you create and manage inventories on your integration. TransactionInitializeRequest , SubAccountCreateRequest , Subscriptions. In live mode, we’ll send webhooks every 3 minutes for the first 4 tries, then we switch to sending hourly for the next 72 Important notes. ; The amount should be in the subunit of the supported currency. The first_name, last_name and phone are optional parameters. You can use these details to make your decision. 0. Request was successful and intended action was carried out. This workspace was designed and constantly maintained to complement our The Paystack API gives you access to pretty much all the features you can use on our dashboard and lets you extend them for use in your application. At the point of payment, you initiate a request to the Create Charge API endpoint, passing the email, amount and bank_transfer object. End-of-day accounting: Each Terminal payment is available in real-time on the Paystack Dashboard and the mobile app, saving you countless hours during reconciliation. A duplicate account number will lead to the retrieval of the existing record. Send money to your customers. We will send you a notification once it is confirmed" 4} Deactivate Dedicated Account . Close. However, when creating a customer that would be assigned a Dedicated Virtual Account and your business category falls under Betting, Financial services, and General Service, Initiating a refund to a customer Bank transfer refunds for Nigeria-based businesses The Refunds page. Without a 200 OK in the response header, we’ll keep sending events for the next 72 hours:. Send single and bulk transfers to Ghanaian bank accounts from your Paystack Dashboard and via API The recipient_code from the data object is the unique identifier for a user and would be used to make transfers to that customer This code should be saved with the customer's records in your database. Create a subscription on your integration Build amazing payment experiences with the Paystack API Build amazing payment experiences with the Paystack API Build amazing payment experiences with the Paystack API. Create multiple transfer recipients in batches. Solution: Please advise the customer to visit the bank and pickup their new card. Cancel. There are 3 major ways of communicating with the API, which are: Paystack Inline; Paystack Standard; Paystack Pages; Understand that the paystack api is a restful api that lives at https://api Learn how to integrate processes in your workflow to ensure you can send money securely and efficiently with Paystack API. Verify transactions after payments using Paystack's verify API. Debit a customer and get a unique token you can use for future charges. Creates a new recipient. Paystack public workspace is a collection of APIs that allow developers and businesses to build amazing payment experiences in Africa. From your Paystack Dashboard, go to the Customers To initiate a refund, you make a POST request to the Create Refund API and pass the transaction ID or reference in the transaction field. A transfer reference is a unique identifier that lets you track, manage and reconcile each transfer request made on your integration. You do this by making a GET request to the Verify Transaction API endpoint from your server using your transaction reference. Coupled with our comprehensive Developer Docs and API Reference, you can explore the various Paystack APIs, from Transactions to Transfers and Account Verification to Subscriptions. Net Request Types that support this feature (e. Learn More Charge Authorization. Once you’ve setup your Paystack account, get your test secret key and add it as a collection variable on the Variables tab on Postman. Goal. When a customer clicks the payment action button, initialize a transaction by making a POST request to our API. There are a few parameters we can pass to the button, but the required ones are: email - All transactions on Paystack require a customer's email address; amount - The amount we're charging the customer; publicKey - Remember, public keys It's a great place to try out new tools and see how customer-facing features look before publicising them. When a subaccount is created, the subaccount_code is returned. The key field here takes your Paystack public key. Initialize transaction. The customer must have already done a transaction on your Paystack integration. Status of transfer object returned will be pending if OTP is disabled. In the event that an OTP is required, status will read otp. api. Why transfer money with Paystack? We’ve worked closely with businesses across Kenya to understand their money transfer needs. Acknowledging an event means returning a 200 OK in the HTTP header. This is because the Subscriptions API uses card authorizations to charge customers, so there needs to be an existing authorization to charge. If an amount isn't passed, we handle the request as a full refund. To install use pip: $ pip install --upgrade paystack or $ easy_install --upgrade paystack See pip-installer for instructions on installing pip. Custom Filters. ; The callback method is called when payment has been completed successfully on the Paystack checkout. How to verify payments. Build custom transfer experiences via API: No matter how particular or complex your business needs are, With our Payment Request API, you can create an invoice that can be fetched and paid on any of your Paystack Terminals. Automatically transfer money to Transfers Control. The data object in the response contains the banks that support account validation. The result is a simple, reliable, and customizable solution that solves many of the issues businesses face. Whether via the API or manually via Verify Payments. Send an event from your application to the Paystack Terminal Some PayStack API allow sending additional information about your request via an optional metadata property. Find everything you need to quickly get started with Paystack APIs. The Paystack Transfer API facilitates the seamless movement of funds between various bank accounts. Kindly ensure you make the transfer from the account you want to link. Your Paystack Dashboard exists in Test Mode when your account is created. ; Click on the Choose File button to upload a spreadsheet Welcome to Paystack's home for real-time and historical data on system performance. Note that it is only the single transfer that was imple You can also create a subscription by calling the create subscription API endpoint, passing a customer and plan. Status of transfer object returned will be pending if OTP is A transfer recipient is a beneficiary on your integration that you can send money to. Fetch the available balance on your integration Build amazing payment experiences with the Paystack API. ; It's ideal to generate a unique reference from your system for every transaction to avoid duplicate attempts. g. Here’re some reasons why you and your customers will love Pay with Transfer: A familiar payment option for customers who're less comfortable with online payment: Many Nigerian customers who aren’t yet comfortable paying online with their debit cards are a lot more comfortable with doing bank Next, click on Transfers from the menu panel, and then on the New Transfer dropdown at the top right dropdown from where you can select the Bulk Upload option. Paystack will send a webhook event with details of the payer account and the receiver account when a customer attempts a transfer to an account. For example, your live public key will look like pk_live_xxxxxxxxxxxxxxxx and your test secret key will look like sk_test_xxxxxxxxxxxxxxxxx. successful or failed). Fetch the payment session timeout on your integration Our documentation gives you full control over the integration process, and you can find a comprehensive guide and our APIs on the Paystack Developer Documentation. It strives to be RESTful and is organized around the main resources you would be Paystack is literally the fastest way to integrate payments into your project, providing a complete API suite that lets developers build amazing custom payments experiences. To send money on Paystack, you need API keys to auth Coupled with our comprehensive Developer Docs and API Reference, you can explore the various Paystack APIs, from Transactions to Transfers and Account Verification to Subscriptions. Authenticate all Paystack API calls using your If you’d like to use a different API testing tool, you can clone or fork the Paystack Open API repository from Github and use the files in the use_cases folder. Check Balance . Transfers between NGN 5,001 and NGN 50,000. The Integration API allows you manage some settings on your integration. Important to note. You can also print out an end-of-day report to show all transactions processed on a particular Terminal device on a given day. Before you begin! You should create a free Paystack account that you can test the API against. Close "We are checking the status of your transfer. Troubleshooting The benefits of accepting payment via Pay with Transfer. Transactions are also available via the API. In Nigeria, whether you’re a school administrator or building school management platforms for educational institutions, Paystack has everything you need to manage payments and offers seamless integration to your school management system. No incidents reported today. We supportdifferent recipients in different countries: The recipient_codefrom the data object is the unique identifi Learn how to integrate our APIs into your application. It strives to be RESTful and is organized around the main resources you would be interacting with - with a few notable exceptions. Business Operations. The Subscriptions API allows you create and manage recurring payment on your integration. Select the Inbound Transfer Approval option and provide a webhook url that will process the webhook events. Do check the data object to know how the charge went (i. The supported_types in each bank object contains an array of the account type that can be validated. NGN 50 per Transfer. Paystack API Quickstart Understand exactly how your business is performing. Processing a transaction is a service that has been Explore public APIs from Paystack, exclusively on the Postman API Network. You can find your API keys here on the Developer/API section of your Paystack Dashboard Settings. Generate a transfer reference. We added a bank. In the meantime, the transaction can be completed using other payments options on the checkout Paystack Transfer Recipients API Reference: Transfer Recipients. Find out how to check balance, use OTP, set server approval and handle transfer requests. This is used in the event that The Paystack Transfer API stands as a powerful tool for businesses seeking streamlined and secure fund transfer capabilities within their applications. Your Paystack Dashboard automatically switches to Live Mode when your compliance documents have been submitted and approved. Create Product . Deactivate a dedicated For example, when your customer chooses the Pay with Transfer option on the Paystack Checkout, we automatically create a virtual bank account number on your behalf, to which they can send the bank transfer. No result found for: Docs API. Pickup card (stolen card) Meaning: This means the customer's card has been reported as lost and a new card has been printed but the customer is yet to pick it up. This is dependent Start sending API requests with the Initiate Transfer public request from Paystack API on the Postman API Network. Create Transfer Recipient . The bank_transfer object takes the account_expires_at which is used to set the expiry of an account Transfer API. The Create Charge API endpoint now takes a bank_transfer object that allows you set the configuration for the account to create. Create Subscription . Refund management You can also create and fetch refunds via the Paystack API. You can find the Transfer Confirmation option under Settings -> Preferences and disable it Transfers. skip to transfer_recipient create; list; update; remove; transfer create; list; get; finalize; bulkTransfer; verify; verification resolveBVN To get the list of bank codes supported, please check this API endpoint: List Banks API. This is dependent on the method you used to initialize the transaction. The Bulk Charges API allows you create and manage multiple recurring payments from your customers. Build amazing payment experiences with the Paystack API Get started with Paystack documentation from Paystack API exclusively on the Postman API Network. You can create Dedicated Virtual Accounts from the Paystack Dashboard, or via API. The Transfers API allows you automate sending money to your customers. PayStack. You'll have to send the reference to your server, then from your server you call the verify endpoint. Build amazing payment experiences with the Paystack API We’ve put together simple projects to demonstrate how the Paystack API works for various financial services. Card Brands (array) If you only want some particular card brand(s) to be accepted for a transaction, specify the brands in the object thus: brands: ["visa","verve"] Start sending API requests with the Initiate Transfer public request from Paystack API on the Postman API Network. Parameters: batch (List[Dict[str, Any]]) – A list of transfer recipient dict keys [ { type, name, account_number, bank_code, currency etc The API keys have the key type and domain appended in them so you can identify them. If the customer's bank is returned in this response, then you can go ahead with Start sending API requests with the Create Transfer Recipient public request from Paystack API on the Postman API Network. Create a payment request for a transaction on your integration Discover APIs in transfer, Paystack by Paystack Developers on Postman Public API Network Payment Requests. Its user-friendly documentation and versatile functionalities empower developers to integrate Verify a transaction. Generates a new OTP and sends to customer in the event they are having trouble receiving one. Setting up your API keys. Recurring Payment. Fetch the payment session timeout on your integration Implementing split payments involves: Create a subaccount; Initialize a split payment; Create a subaccount. Secret Keys Products. Send Event . Our Developer Documentation contains interactive Payment Requests. Troubleshooting. The Terminal API allows you to build delightful in-person payment experiences. The bank_transfer object takes the account_expires_at which is used to set the expiry of an account NGN 10 per Transfer. Automatically transfer money to customers' bank accounts with one API call. async bulk_create_transfer_recipient(batch: List[Dict[str, Any]])→ PayStackResponse. Typically, the account number and associated bank should suffice, but some countries require more details particularly for account verification. Here’s how quickly you can send money on Paystack. Please note that our transaction charges are non-refundable. You can learn more on the Pay with Transfer section. After making the transfer, click ‘I have made the transfer’. Live Mode is where everything real happens. Create a payment request for a transaction on your integration Click ‘Next’ to save the information and initiate a bank transfer to the account details we will provide. We will provide you with test keys that you can use to make API calls. Note that we will always send a 200 if a charge or verify request was made. If the API call Crown your favorite API in the 2025 Developers' Choice Awards Cast your vote to support your favorite APIs and watch them climb the leaderboard in the Postman Developers' Choice Awards! Vote for Paystack Developers See the Leaderboard When your webhook URL receives an event, it needs to parse and acknowledge the event. Integration. Before you begin. Custom filters allow you control how a transaction is completed by using the custom_filters object in the metadata object. transfer. Paystack provides detailed reporting, alerts, and exports, so you and your team are always on top of business. Pass in the account_expires_at param to set the expiry time. Initiate Bulk Charge Send an array of objects with authorization codes and amount, using the supported currency format, so we can process transactions as a batch. Sign up. Home; Payments. If you are on a system with easy_install but not pip, you can use easy_install instead. API Response Time Fetching. Start using paystack-api in your project by running `npm i paystack-api`. Create Payment Request . Once your transfer is confirmed, you will be asked to authorize the business to charge your account. ussd. This is affecting transfers to bank accounts. Apr 29, 2025. . Need something else? Our Transfers feature allows you to send money from your Paystack Balance to bank accounts in your country. Installation / Usage. Virtual Accounts. Unlike our usual pricing, transaction fees for schools or educational institutions are NGN 300. At the end of this guide, you'll have set up a Fetch all pay-ins and pay-outs that occured on your integration. This feature is crucial for businesses handling disbursements, payroll, customer withdrawals, vendor payments, etc. Sometimes, the processor might send a reversal notice due to their inability to credit the customer’s account. The Payment Requests API allows you manage requests for payment of goods and services. Fetch the available balance on your integration You need to disable the OTP requirement to use this feature. Learn how to send money with Paystack. When we get this notice, we send a transfer. Build amazing payment experiences with the Paystack API Paystack is literally the fastest way to integrate payments into your project, providing a complete API suite that lets developers build amazing custom payments experiences. This allows you to receive payments easily while also automating reconciliation. Search Menu. From Popup or Mobile SDKs. Create a product on your integration Over 200,000 businesses of all sizes use Paystack to collect payments with a modern, secure payment gateway. Overview; Accept Payments; Webhooks; Verify Payments (transfer) 000 At the point of payment, you initiate a request to the Create Charge API endpoint, passing the email, amount and bank_transfer object. Before sending money to your customer, you need tocollect their details first, then use their details to create a transfer recipient. Terminal. This guide shows you how to top up your Paystack Balance and transfer money from your Paystack Dashboard →; If you’d like to send bulk money transfers from the Dashboard, this guide shows you how in detail →; To learn how to send money with Paystack via the API, check out our developer documentation on Transfers → In this video, we learned how to create a cash transfer app in Paystack API using their transfer APi. Home; Payments Make a transfer. Initiate Transfer . docs. failed event. Fetch Timeout . Gift Store No result found for: Docs API. rejected event which is sent when a customer sends an incorrect amount or when the customer has been flagged by our fraud system Build amazing payment experiences with the Paystack API. The Transfers Control API allows you manage settings of your transfers. Transfers above NGN 50,000. There are 2 other projects in the npm registry using paystack-api. Build custom transfer experiences via API: No matter how complex or unique your business needs are, the Paystack Transfers API allows you to easily build a solution that gives you fine-grained control over how you send money. Investigating - Ghana's central transfer switch is currently experiencing an unexpected downtime. e. Home. Some banks only support personal accounts while others support both personal and business accounts. Pass the email, amount and any other parameters to the Initialize Transaction API endpoint. Sign up Build amazing payment experiences with the Paystack API When creating a transfer recipient with a bank account, you need to collect the customer’s bank details. Meaning: OTP requirement has to be disabled to use the Bulk Transfers API Solution: You'll need to disable the OTP for Transfers requirement from your Dashboard. When building or maintaining your transfer integration, you should keep the following integration checklist in mind: Ensure you have enough funds in your Paystack balance to carry out the request(s) The Transfer Recipients API allows you create and manage beneficiaries that you send money to. See the next section to see for how to Build amazing payment experiences with the Paystack API Latest version: 2. Build amazing payment experiences with the Paystack API. The Transfers API allows you automate sending money to your customers. The integration flow is a three-step process: Create a customer, if one doesn't exist already, with the Customer API Request was successful and intended action was carried out. reversed event and credit your Paystack balance back. Subaccounts can be created via the Paystack Dashboard or using the create subaccount API endpoint. Paystack API bindings in Python. Automatically transfer money directly to your customers' bank accounts. yovuel yljwem wrv wzmhppn wfxjk bdgla nocxf cfdmtmjx fazmibz zesx kiturv tnyso zhu wwxrni loh