Paystack

Paystack Savings API

The OpenAPI specification for creating a savings application using the [Paystack API](https://paystack.com/docs/api/). Prerequisites 1. Sign up on…

Payments#openapi

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 savings application using the Paystack API.

Prerequisites

  1. Sign up on Paystack to get your secret API key
  1. Set your API key as an environment variable on Postman

Once setup, start with the Initialize Transaction endpoint, where you'll open the authorization_url to load the Paystack Checkout and complete the transaction.

Endpoints 7

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

Bank

  • GETResolve Account Number/bank/resolve?account_number=22728151&bank_code=63Resolve an account number to confirm the name associated with it

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
7 operations on 5 pathsPOST 4GET 3
Main resources
Transaction 2Transfer 2Transfer Recipient 2Bank 1
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.0.0

How to test the Paystack Savings API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Paystack Savings API collection, without the publisher's secrets.
  3. 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.
  4. 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 Savings API?

The OpenAPI specification for creating a savings application using the [Paystack API](https://paystack.com/docs/api/). Prerequisites 1. Sign up on… It is listed under Payments and has 7 endpoints.

Who publishes the Paystack Savings 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 Savings API?

Requests go to https://api.paystack.co. Endpoint paths are added to this base URL.

How do I authenticate with the Paystack Savings API?

With A bearer token in the Authorization header.

How many endpoints does the Paystack Savings API have?

7 operations on 5 paths (4 POST, 3 GET). The largest groups are Transaction, Transfer, Transfer Recipient, Bank.

Is forking the Paystack Savings API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.