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.

query {
  getTransactions(from:"2021-08-01", to:"2021-09-01") {
    transactions {
      id
      reference
      amount
      sourceBankAccount
      sourceBankAccountName
      destinationBankAccount
      description
      createdAt
      status
    }
    paging{
      total
      page
      pages
    }
  }
}

Response:

{
  "data": {
    "getTransactions": {
      "transactions": [
        {
          "id": "0afc3d1f-eebc-4609-8d78-75e9ad560492",
          "reference": "ref000100",
          "amount": 100,
          "sourceBankAccount": "1234567890",
          "sourceBankAccountName": "FirstName MiddleName LastName",
          "destinationBankAccount": "0123456789",
          "description": "",
          "createdAt": "2021-08-06T21:24:29.260101+01:00",
          "status": "Pending"
        }
      ],
      "paging": {
        "total": 1,
        "page": 1,
        "pages": 1
      }
    }
  }
}

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