Get Transactions

Clients can retrieve all payment transactions initiated/authorized via the Transfers API by calling the getTransactions query.
The query can be filtered by status, date range (from and to), and page number.
1
query {
2
  getTransactions(from:"2021-08-01", to:"2021-09-01") {
3
    transactions {
4
      id
5
      reference
6
      amount
7
      sourceBankAccount
8
      sourceBankAccountName
9
      destinationBankAccount
10
      description
11
      createdAt
12
      status
13
    }
14
    paging{
15
      total
16
      page
17
      pages
18
    }
19
  }
20
}
Copied!
Response:
1
{
2
  "data": {
3
    "getTransactions": {
4
      "transactions": [
5
        {
6
          "id": "0afc3d1f-eebc-4609-8d78-75e9ad560492",
7
          "reference": "ref000100",
8
          "amount": 100,
9
          "sourceBankAccount": "1234567890",
10
          "sourceBankAccountName": "FirstName MiddleName LastName",
11
          "destinationBankAccount": "0123456789",
12
          "description": "",
13
          "createdAt": "2021-08-06T21:24:29.260101+01:00",
14
          "status": "Pending"
15
        }
16
      ],
17
      "paging": {
18
        "total": 1,
19
        "page": 1,
20
        "pages": 1
21
      }
22
    }
23
  }
24
}
Copied!
Request Parameters
Field
Scalar
Required
Description
to
String
No
This applies a filter by status
from
String
No
This applies a filter by start date
status
String
No
This applies a filter by end date
page
Int
No
This applies a filter by page number
Response
Field
Scalar
Required
Description
transactions
​[Transaction]​
Yes
This return the transactions found
paging.total
Int
No
The total number of records matching filters
paging.page
Int
No
The current pagination page
paging.pages
Int
No
The total number of pages

Connect API - Previous

Get Transaction

Next - Connect API

Fetch BVN

Last modified 2mo ago

Copy link

Contents

Request Parameters

Response