Qodex.ai

Create a membership app

Number of APIs: 4

The OpenAPI specification for creating a membership application using the Paystack API.

Prerequisites

  1. Sign up on Paystack to get your secret API key
  2. Set your API key as an environment variable on [Qodex]

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.

The OpenAPI specification for creating a lending application using the Paystack API.

Prerequisites

  1. Sign up on Paystack to get your secret API key
  2. Set your API key as an environment variable on [Qodex]

The Partial Debits feature allows you to recover some revenue that would have otherwise been lost. It is currently available on request.

Prerequisites

  1. Sign up on Paystack and retrieve your test Secret API Key. (see guide for more)
  2. Setup your API key as a collection variable on Qodex
  3. Checkout our Developer Docs and API Reference for detailed explanations

Getting Started

We’re going to assume you’ve already signed up on Paystack

Adding the collection to your Qodex

Go to the [Paystack’s public workspace] on Qodex and fork the collection you’re interested in testing.

Give your collection a memorable label to differentiate it from the original collection and add it to your preferred workspace. Checking the “Watch original collection” option allows your collection to get updated as we update the collection.

After importing it, you should see it in your collections sidebar with the label you provided.

Import collection from Github

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.

Setting up your API keys

Once you’ve setup your Paystack account, get your test secret key and add it as a [collection variable] on the Variables tab on Qodex.

Switch to the Authorization tab and clear the Token field and use two curly braces and enter the variable name you setup.

The value of secret_key should appear when you hover your mouse on the variable as shown below.

If everything looks good, save your changes and you’re ready to explore the collection!

Using the collection

Each endpoint in the collection has example request data and responses. The responses show you how the API responds in different scenarios.

  1. Create Subscription POST {{baseUrl}}/subscription

  2. Create Plan POST {{baseUrl}}/plan

  3. transaction - Initialize Transaction POST {{baseUrl}}/transaction/initialize

  4. transaction - Charge Authorization POST {{baseUrl}}/transaction/charge_authorization