Account - Use Case and Examples

Use Cases

The end user wants to get the list of accounts from the bill pay system, or the user wants to get a specific account from the bill pay system.

The user in this case is the customer of financial institution (FI).

Gets the accounts for the given institution customer

Get list of accounts GET /db-accounts/v1/accounts
- Request:
  - Query Parameters:
    - hostUserId: The specific identifier for that customer
- Headers:
  - Authorization: The bearer access token from the Authentication API
  - TransactionId: A UUID string used as unique identifier for this token request

Get the specified account for the given user

Get the accounts GET /db-accounts/v1/accounts/{accountId}
- Request:
  - Headers:
    - Authorization: The access token from the Authentication API
    - TransactionId: A UUID string used as unique identifier for this token request

Example Code

Here’s an excerpt from the Accounts service:

Get the accounts for the given institution customer

Sample Response:

{
    "accounts": [
        {
            "id": "J8fhcO2UzfqChL84fZe3odg6PQbwUalR5ncGh7cs1io",
            "institutionCustomerId": "9ff9f3b4293d45e6897e7e71b00fdb36",
            "institutionId": "01099",
            "description": "Unknown Account Type DITYP -1",
            "nickName": "Unknown Account Type DITYP -1",
            "hostAccountNumber": "7362811980001^GARBAGE",
            "accountNumber": "7362811980001",
            "category": "DEPOSIT",
            "type": {
                "value": "UNKNOWN",
                "fiAccountType": 7321,
                "description": "UNKNOWN"
            },
            "ownershipType": "PRIMARY",
            "currentBalance": {
                "currencyCode": "USD",
                "amount": 84.03
            },
            "availableBalance": {
                "currencyCode": "USD",
                "amount": 38.03
            },
            "status": {
                "open": true,
                "closed": false,
                "negativeBalance": false,
                "delinquent": false,
                "inCollection": false,
                "overLimit": false,
                "writtenOff": false,
                "creditBalance": false,
                "paymentCoupon": false,
                "retirementPlan": false,
                "retPlanOwnedByDeceased": false
            },
            "allowedActions": {
                "summary": true,
                "transferFrom": true,
                "transferTo": true,
                "isHistoryEnabled": true,
                "isHistoryEntitled": true
            },
            "isAccountHybrid": false,
            "isVisible": true,
            "isHiddenByFi": false
        },
        {
            "id": "tpR34C0gQheG1o4IkhyNmWSgj2Dh2TMmT45GNw-_D10",
            "institutionCustomerId": "9ff9f3b4293d45e6897e7e71b00fdb36",
            "institutionId": "01099",
            "description": "Unknown Account Type ATYP AND DITYP -1",
            "nickName": "Unknown Account Type ATYP AND DITYP -1",
            "hostAccountNumber": "7362811980002^GARBAGE",
            "accountNumber": "7362811980002",
            "category": "DEPOSIT",
            "type": {
                "value": "UNKNOWN",
                "fiAccountType": -1,
                "description": "UNKNOWN"
            },
            "ownershipType": "PRIMARY",
            "currentBalance": {
                "currencyCode": "USD",
                "amount": 84.04
            },
            "availableBalance": {
                "currencyCode": "USD",
                "amount": 38.04
            },
            "status": {
                "open": true,
                "closed": false,
                "negativeBalance": false,
                "delinquent": false,
                "inCollection": false,
                "overLimit": false,
                "writtenOff": false,
                "creditBalance": false,
                "paymentCoupon": false,
                "retirementPlan": false,
                "retPlanOwnedByDeceased": false
            },
            "allowedActions": {
                "summary": true,
                "transferFrom": true,
                "transferTo": true,
                "isHistoryEnabled": true,
                "isHistoryEntitled": true
            },
            "isAccountHybrid": false,
            "isVisible": true,
            "isHiddenByFi": false
        },
        ...
    ]
}

Get the specified account for the given user

‍Sample Response:

‍

 {
            "id": "J8fhcO2UzfqChL84fZe3odg6PQbwUalR5ncGh7cs1io",
            "institutionCustomerId": "9ff9f3b4293d45e6897e7e71b00fdb36",
            "institutionId": "01099",
            "description": "Unknown Account Type DITYP -1",
            "nickName": "Unknown Account Type DITYP -1",
            "hostAccountNumber": "7362811980001^GARBAGE",
            "accountNumber": "7362811980001",
            "category": "DEPOSIT",
            "type": {
                "value": "UNKNOWN",
                "fiAccountType": 7321,
                "description": "UNKNOWN"
            },
            "ownershipType": "PRIMARY",
            "currentBalance": {
                "currencyCode": "USD",
                "amount": 84.03
            },
            "availableBalance": {
                "currencyCode": "USD",
                "amount": 38.03
            },
            "status": {
                "open": true,
                "closed": false,
                "negativeBalance": false,
                "delinquent": false,
                "inCollection": false,
                "overLimit": false,
                "writtenOff": false,
                "creditBalance": false,
                "paymentCoupon": false,
                "retirementPlan": false,
                "retPlanOwnedByDeceased": false
            },
            "allowedActions": {
                "summary": true,
                "transferFrom": true,
                "transferTo": true,
                "isHistoryEnabled": true,
                "isHistoryEntitled": true
            },
            "isAccountHybrid": false,
            "isVisible": true,
            "isHiddenByFi": false
        }

Use Cases

Example Code

Get the specified account for the given user

Sign in now!