👀USSD Activity Log

Gain insight into the activity logs of the USSD Session for a Customers Bank Account ID.

USSD Session Activity Logs

GET {{baseUrl}}/bank-accounts/:bank_account_id/ussd/:ussd_session_code/activity-logs

Path Parameters

Key	Type	Description
bank_account_id*	String	The UUID for a Bank Account that gets generated and returned in the POST Create new Bank Account response.
ussd_session_code*	String	The UUID generated and returned in the POST USSD Statement Collection response.

200: OK USSD session created

```postman_json
{
    "data": {
        "bank": "capitec",
        "uuid": "{{bankAccountId}}",
        "state": [
            "session-created"
        ],
        "ussd_session_code": "{{ussdSessionCode}}",
        "accounts": [],
        "timestamp": "2023-07-26T13:55:23.000000Z"
    }
}
```

200: OK USSD successful collection - Desktop

```postman_json
{
    "data": {
        "bank": "fnb",
        "uuid": "{{bankAccountId}}",
        "state": [
            "session-created",
            "session-activated",
            "link-sent",
            "link-activated",
            "statement-received",
            "customer-linked",
            "statement-processed"
        ],
        "ussd_session_code": "{{ussdSessionCode}}",
        "accounts": [
            {
                "accountNumber": "62938032001",
                "accountName": "FNB PREMIER CURRENT ACCOUNT",
                "accountHolder": "MISS KIRSTEN J HANCOCK"
            }
        ],
        "timestamp": "2023-07-26T12:37:10.000000Z"
    }
}
```

200: OK USSD successful collection - Mobile

```postman_json
{
    "data": {
        "bank": "fnb",
        "uuid": "{{bankAccountId}}",
        "state": [
            "session-created",
            "session-activated",
            "link-activated",
            "statement-received",
            "customer-linked"
        ],
        "ussd_session_code": "{{ussdSessionCode}}",
        "accounts": [
            {
                "accountNumber": "62938032000",
                "accountName": "FNB PREMIER CURRENT ACCOUNT",
                "accountHolder": "MISS Jane J Doe"
            }
        ],
        "timestamp": "2023-07-26T12:58:26.000000Z"
    }
}
```

USSD Session States

USSD Session State	Description
“session-created”	USSD URL and session has been created within the POST USSD statement collection endpoint.
"session-activated”	USSD webview page has been opened and the user is reading through the landing page/inserting their bank account and mobile number details.
"link-sent"	Device type has been identified as 'desktop', as such an SMS has been sent to the user.
“link-activated"	User has initiated the dialpad link.
"statement-received”	Statement has been received from the user.
"customer-linked”	Statement has been linked to the customerID, bankAccountID and ussdSessionCode.
“statement-processed”	Statement has been processed and transaction data is available.
“session-expired”	ussdSessionCodehas expired. Expiry of the session is set at 30 minutes.