Sign in

v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB
Real-Time Data

Request Bank Account Data

Request the current balance for a bank account

post/v1/users/{userId}/bankAccounts/{bankAccountId}/lookup

Path parameters

userIdstring required
bankAccountIdstring required

Request body

extRequestIdstring required

The external id for the refresh

Example request

{
  "extRequestId": "53ec068e-3ae0-4e40-826e-eaa007e1426f"
}

Response

Successful response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "bankAccountId": "53ec068e-3ae0-4e40-826e-eaa007e1426f",
    "userId": "53ec068e-3ae0-4e40-826e-eaa007e1426f",
    "refreshTransactionId": "53ec068e-3ae0-4e40-826e-eaa007e1426f",
    "extRequestId": "53ec068e-3ae0-4e40-826e-eaa007e1426f",
    "refreshTransactionStatus": "IN_PROGRESS"
  }
}