Sign in

v1

latestOpenAPI 3.0.32026-07-248257161.1 KB
Balance

Retrieve merchant balance

This API endpoint is used to retrieve current balance

get/balance/me

Response

The balance is retrieved

idstring uuid

Unique identifier of the balance Object

type'payment' | 'transfer' | 'refund' | 'settlement'

type of transaction

amountinteger

correspond to available balance, available for transfer

pendingAmountinteger

correspond to pending balance, usually correspond to card checkout.

currencystring

The currency associated to the amount. If you don't specify a value, we'll assume 'XOF'

timestampstring date-time

The time and date that the the transaction was recorded in our system. Note that this doesn't describe when payments were executed, only when they were submitted

Example response

{
  "id": "33e1c83b-7cb0-437b-bc50-a7a58e5660ad",
  "amount": 10000,
  "pendingAmount": 40000,
  "currency": "XOF",
  "timestamp": "2022-06-20T17:17:11Z"
}