Paystack

Paystack Membership API

The OpenAPI specification for creating a membership 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 membership 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

When using the Subscriptions API, Paystack automatically charges the customer at the due time.
This saves you the need to run scheduled tasks for every customer.

While with the Charge Authorization API, you send Paystack the charge details at the due time.

Endpoints 6

Plan

  • GETList Plans/plan?perPage=0&page=0&interval=daily&amount=0&from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00ZList all recurring payment plans
  • POSTCreate Plan/planCreate a plan for recurring payments

Subscription

  • GETList Subscriptions/subscription?perPage=0&page=0&plan=2697466&customer=string&from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00ZList all subscriptions available on your integration
  • POSTCreate Subscription/subscriptionCreate a subscription a customer

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

API details

Base URL
https://api.paystack.co
Authentication
A bearer token in the Authorization header
Operations
6 operations on 4 pathsPOST 4GET 2
Main resources
Plan 2Subscription 2Transaction 2
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.0.0

How to test the Paystack Membership 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 Membership 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 “List Plans” (GET /plan?perPage=0&page=0&interval=daily&amount=0&from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00Z), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Paystack Membership API?

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

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

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

How do I authenticate with the Paystack Membership API?

With A bearer token in the Authorization header.

How many endpoints does the Paystack Membership API have?

6 operations on 4 paths (4 POST, 2 GET). The largest groups are Plan, Subscription, Transaction.

Is forking the Paystack Membership 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.