Paystack

Paystack Balance API

The Balance API from Paystack — 2 operation(s) for balance.

Documentation GitHub OpenAPI

Documentation

https://paystack.com/docs/api/transaction/

https://paystack.com/docs/api/charge/

https://paystack.com/docs/api/subscription/

https://paystack.com/docs/api/plan/

https://paystack.com/docs/api/customer/

https://paystack.com/docs/api/transfer/

https://paystack.com/docs/api/transfer-recipient/

https://paystack.com/docs/api/bulk-charge/

https://paystack.com/docs/api/split/

https://paystack.com/docs/api/subaccount/

https://paystack.com/docs/api/dedicated-virtual-account/

https://paystack.com/docs/api/products/

https://paystack.com/docs/api/page/

https://paystack.com/docs/api/payment-request/

https://paystack.com/docs/api/refund/

https://paystack.com/docs/api/dispute/

https://paystack.com/docs/api/settlement/

https://paystack.com/docs/api/verification/

https://paystack.com/docs/api/balance/

https://paystack.com/docs/api/integration/

Specifications

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/openapi/paystack-balance-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-schema/paystack-transaction-schema.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-structure/paystack-transaction-structure.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-schema/paystack-plan-schema.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-schema/paystack-subscription-schema.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-structure/paystack-subscription-structure.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-schema/paystack-customer-schema.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-structure/paystack-customer-structure.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-schema/paystack-transfer-schema.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-structure/paystack-transfer-structure.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-schema/paystack-split-schema.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-schema/paystack-subaccount-schema.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-structure/paystack-split-structure.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-schema/paystack-refund-schema.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/json-schema/paystack-dispute-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/examples/paystack-initialize-transaction-example.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/examples/paystack-verify-transaction-example.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/graphql/paystack-graphql.md

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/examples/paystack-create-subscription-example.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/examples/paystack-initiate-transfer-example.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/examples/paystack-create-split-example.json

https://raw.githubusercontent.com/api-evangelist/paystack/refs/heads/main/examples/paystack-create-dedicated-account-example.json

OpenAPI Specification

openapi: 3.0.1
info:
  title: Paystack Accept Payments Balance API
  description: Initialize, verify, charge, and manage one-time card, bank, USSD, mobile money, and QR payments. The core API for accepting payments through Paystack across Africa.
  version: 1.0.0
  contact:
    name: Paystack Support
    url: https://support.paystack.com
    email: support@paystack.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://api.paystack.co
  description: Base API endpoint
security:
- bearerAuth: []
tags:
- name: Balance
paths:
  /balance:
    get:
      tags:
      - Balance
      summary: Fetch Balance
      operationId: balance_fetch
      description: Check your Paystack account balance
      responses:
        '200':
          $ref: '#/paths/~1plan/get/responses/200'
        '401':
          $ref: '#/paths/~1plan/get/responses/401'
        '404':
          $ref: '#/paths/~1plan/get/responses/401'
        default:
          description: Server error
  /balance/ledger:
    get:
      tags:
      - Balance
      summary: Balance Ledger
      operationId: balance_ledger
      parameters:
      - in: query
        name: perPage
        schema:
          type: integer
        description: Number of records to fetch per page
      - in: query
        name: page
        schema:
          type: integer
        description: The section to retrieve
      - in: query
        name: from
        schema:
          type: string
          format: date-time
        description: The start date
      - in: query
        name: to
        schema:
          type: string
          format: date-time
        description: The end date
      responses:
        '200':
          $ref: '#/paths/~1plan/get/responses/200'
        '401':
          $ref: '#/paths/~1plan/get/responses/401'
        '404':
          $ref: '#/paths/~1plan/get/responses/401'
        default:
          description: Server error
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer