Get the transactions of your wallets

GET 
/v1/partners/wallet/transactions

This endpoint allows you to retrieve the transactions that has occured on your wallets

Request

Query Parameters

type string
Possible values: [credit, debit]
The type of transaction. Can be either credit or debit
Example: credit
currency string
Restrict the results to a specific currency
Example: NGN
dateRange json
Filter transactions by a date range.
Example: {"start": "2019-01-01", "end": "2019-12-31"}
search string
The search query to filter the transactions by. You can search by transaction reference or transaction narration.
Example: lorem ipsum
per_page integer
Default value: 16
The number of results to return per page. Default is 16.
Example: 10
page integer

Default value: 1

The page number to retrieve. Default is 1

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
id integer
The unique ID of the transaction
ref string
The unique reference of the transaction
narration string
The description of the transaction
amount float
The amount of the transaction
currency string
The currency of the transaction
type string
The type of the transaction. One of: DEBIT, CREDIT
opening_bal float
The balance of the account before the transaction
closing_bal float
The balance of the account after the transaction
created_at date
The date and time the transaction was created
]

Example (from schema)

{
  "data": [
    {
      "id": 8,
      "ref": "PH-34243TF",
      "narration": "Lorem ipsum...",
      "amount": 1470,
      "currency": "GHS",
      "type": "CREDIT",
      "opening_bal": 3500,
      "closing_bal": 4970,
      "created_at": "2022-03-12T14:19:50.000000Z"
    }
  ]
}

400

Bad request.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "400 Bad Request (Client Error)"
}

Loading...