Fetch All Connections

You can retrieve all linked bank accounts information for a user with the fetchAllConnections query. The id parameter is the unique identifier of the user on the client's end.

Query

query {
fetchAllConnections(id:"dev001") {
    id
    username
    slug
    defaultAccount
    accountNumber
    balance
  }
}

Response :

{
  "data": {
    "currentConnections": [
      {
        "id": "dev001",
        "username": "1234567890",
        "slug": "gtbank",
        "defaultAccount": false,
        "accountNumber": "0123456789",
        "balance": "143.03"
      }
    ]
  }
}

Request Parameters

Field Name	Scalar	Mandatory Field	Description
id	ID	Yes	The unique identifier of the user in the client's service

Response

Field Name	Scalar	Mandatory Field	Description
id	ID	Yes	This would be the unique id of the user according to Transfers
username	String	Yes	The bank's profile username
slug	BankType	Yes	The slug id for the bank name
defaultAccount	Boolean	Yes	This identifies if this is the default debit account
accountNumber	String	Yes	This is the account number returned on the bank profile
balance	String	Yes	This is the account balance returned on the bank account from the bank profile