Paystack

Paystack Marketplace API

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

The Split API is useful in marketplace apps where the transactions are divided between the platform and the vendor.
That way, the platform keeps a portion of each transaction.

Endpoints 7

Subaccount

  • GETList Subaccounts/subaccount?perPage=50&page=1&active=trueList subaccounts available on your integration
  • POSTCreate Subaccount/subaccountCreate a subacount for a partner

Split

  • GETList Splits/split?subaccount_code=ACCT_dskvlw3y3dMukmt&name=string&active=true&per_page=0&page=0&from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00ZList the transaction splits available on your integration
  • POSTCreate Split/splitCreate a split configuration for transactions

Transaction

  • POSTInitialize Transaction/transaction/initializeCreate a new transaction

Refund

  • GETList Refunds/refund?perPage=10&page=0&from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00ZList previously created refunds
  • POSTCreate Refund/refundInitiate a refund for a previously completed transaction

API details

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

How to test the Paystack Marketplace 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 Marketplace 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 Subaccounts” (GET /subaccount?perPage=50&page=1&active=true), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Paystack Marketplace API?

The OpenAPI specification for creating a marketplace 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 Marketplace 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 Marketplace API?

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

How do I authenticate with the Paystack Marketplace API?

With A bearer token in the Authorization header.

How many endpoints does the Paystack Marketplace API have?

7 operations on 4 paths (4 POST, 3 GET). The largest groups are Refund, Split, Subaccount, Transaction.

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