Bank Statement

With the Connect API, you can pull up to 12 months of bank transactional statements for your users when they link their bank accounts.

The periodic bank statement extraction process occurs once a day. This query will return records up to the last extraction date (statement record might be 24 hours late).

Retrieving User Bank Statement

You can retrieve bank statement information for a user's connected bank account with the getBankStatement query.

This query will return nil records if the bank statement sync is pending for the user.

query{
  getBankStatement(
  userId: "test_user_id",
  accountNumber: "123456789",
  bankCode: "057",
  from: "2021-08-10",
  to: "2021-08-11"
  ){
    id
    userId
    merchantId
    type
    amount
    reference
    narration
    sourceAccountNumber
    sourceBankCode
    destinationAccountNumber
    destinationBankCode
    transactionDate
  }
}

Response

{
  "data": {
    "getBankStatement": [
      {
        "id": "601a17e2-9693-486d-8548-5166d3db8880",
        "userId": "8f76ca1f-abb8-43e2-9343-300a71ba6831",
        "merchantId": "59daa2b2-7a13-407c-9f31-581264bbbafa",
        "type": "debit",
        "amount": 100000,
        "reference": "NIP-DCO-1906997585",
        "narration": "NIP CR/OJEI RUTH NONYELICHUKWU/GTB",
        "sourceAccountNumber": "2110455907",
        "sourceBankCode": "057",
        "destinationAccountNumber": "2110455907",
        "destinationBankCode": "",
        "transactionDate": "2021-08-10T14:56:09Z"
      },
      {
        "id": "2cf39d5e-f6e8-4d52-93ca-8c0f0259f750",
        "userId": "8f76ca1f-abb8-43e2-9343-300a71ba6831",
        "merchantId": "59daa2b2-7a13-407c-9f31-581264bbbafa",
        "type": "debit",
        "amount": 9528,
        "reference": "202108101610280567A7",
        "narration": "MC Loc POS Prch-081021629004--2011LA018833603          LA           NG-",
        "sourceAccountNumber": "2110455907",
        "sourceBankCode": "057",
        "destinationAccountNumber": "2110455907",
        "destinationBankCode": "",
        "transactionDate": "2021-08-10T16:10:28Z"
      },
    ]
  }
}

Request Parameters

Field Name	Scalar	Mandatory Field	Description
userId	ID	Yes	This is a unique identifier for the user on the client's end
accountNumber	String	Yes	The account number to retrieve bank statement for
bankCode	String	Yes	The bank code of the source account.
from	String	Yes	Start date of transaction period
to	String	Yes	End date of transaction period

Response

Field Name	Scalar	Mandatory Field	Description
id	ID	Yes	This is a unique identifier for the transaction on the client's end
userId	ID	Yes	This is a unique identifier for the user on the client's end
merchantId	ID	Yes	The client's identification on Transfers
type	String	Yes	The payment direction type (credit or debit)
amount	Float	Yes	The amount that was transacted
reference	String	Yes	The transaction reference
narration	String	Yes	The transaction narration/summary
sourceAccountNumber	String	Yes	The source account for this transaction
sourceBankCode	String	Yes	The bank code for the source account
destinationAccountNumber	String	Yes	The recipient account for this transaction
destinationBankCode	String	Yes	The bank code for the recipient account
transactionDate	String	Yes	The date this transaction occurred