๐Ÿ‘€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

View the GathrUSSD session activity logs for a customers bankaccountid.

Path Parameters

NameTypeDescription

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.

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

USSD Session States

USSD Session StateDescription

โ€œ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.

Last updated