Paystack Wallet API
The OpenAPI specification for creating a wallet application using the [Paystack API](https://paystack.com/docs/api/). Prerequisites 1. Sign up on…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The OpenAPI specification for creating a wallet application using the Paystack API.
Prerequisites
- Sign up on Paystack to get your secret API key
- Set your API key as an environment variable on Postman
After setting up your secret API key, use the Customers API to create and validate a customer.
You then assign a Dedicated Virtual Account to the customer.
Transfers in this case refer to moving money to bank accounts and mobile money accounts using our Transfers API rather than other wallet users.
Dedicated Virtual Account is currently available for registered businesses in Nigeria.
Endpoints 11
Transaction
- POSTInitialize Transaction
/transaction/initializeCreate a new transaction - POSTCharge Authorization
/transaction/charge_authorizationCharge all authorizations marked as reusable with this endpoint whenever you need to receive payments
Customer
- GETList Customers
/customer?use_cursor=true&next=string&previous=string&from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00Z&perPage=string&page=stringList customers on your integration - POSTCreate Customer
/customerCreate a customer on your integration - POSTValidate Customer
/customer/:code/identificationValidate a customer's identity
Dedicated Virtual Account
- GETList Dedicated Accounts
/dedicated_account?active=true&customer=297346561¤cy=NGN&provider_slug=titan-paystack&bank_id=035&perPage=50&page=1List dedicated virtual accounts available on your integration. - POSTCreate Dedicated Account
/dedicated_accountCreate a dedicated virtual account for an existing customer
Transfer Recipient
- GETList Transfer Recipients
/transferrecipient?use_cursor=true&next=string&previous=string&per_page=0&page=0List transfer recipients available on your integration - POSTCreate Transfer Recipient
/transferrecipientCreates a new recipient. A duplicate account number will lead to the retrieval of the existing record.
Transfer
- GETList Transfers
/transfer?use_cursor=true&next=string&previous=string&per_page=0&page=0&from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00Z&recipient=string&status=pendingList the transfers made on your integration - POSTInitiate Transfer
/transferSend money to your customers
API details
- Base URL
https://api.paystack.co- Authentication
- A bearer token in the Authorization header
- Operations
- 11 operations on 7 pathsPOST 7GET 4
- Main resources
- Customer 3Dedicated Virtual Account 2Transaction 2Transfer 2Transfer Recipient 2
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- Paystack's published OpenAPI description (PaystackOSS/openapi) (MIT)
How to test the Paystack Wallet API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Paystack Wallet API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Initialize Transaction” (POST /transaction/initialize), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Paystack Wallet API?
The OpenAPI specification for creating a wallet application using the [Paystack API](https://paystack.com/docs/api/). Prerequisites 1. Sign up on… It is listed under Payments and has 11 endpoints.
Who publishes the Paystack Wallet API?
It is listed from Paystack's public API description (an OpenAPI document), not published by Paystack on Swastik Codes. Anyone who controls paystack.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Paystack Wallet API?
Requests go to https://api.paystack.co. Endpoint paths are added to this base URL.
How do I authenticate with the Paystack Wallet API?
With A bearer token in the Authorization header.
How many endpoints does the Paystack Wallet API have?
11 operations on 7 paths (7 POST, 4 GET). The largest groups are Customer, Dedicated Virtual Account, Transaction, Transfer.
Is forking the Paystack Wallet API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.