Register

Get Statement API

This service provides access to the transactional activities of ALAT/WEMA bank customers.

How does it work?

The Get statement API service uses a three-step API call to validate/authorize access to customer's bank transaction records.

  • A call by the requesting party to initiate request to retrieve customer's transaction records.

  • An approval - granted by the customer using the ALAT mobile application.

  • A response/callback by the requesting party to retrieve approved records.

Go Live

Step 1: InitiateGetCustomerStatement

Request URL

POST - {baseURL}/get-statement-service/api/AccountMaintenance/GetCustomerTransactions

Try it out !

  1. The requesting party initiates the request on behalf of the customer. Required parameters can be seen on the API details page.

  2. A referenceId is returned. This value should be maintained by the requesting party.

  3. Only one active request is permitted per user per time.

  4. An active request would maintain a PENDING status. The status changes when either

    • the customer APPROVES/REJECTS, OR

    • when the request expires.

  5. A request is active for 15 minutes before its expiration.

  6. A customer can provide consent within the duration of the active window.

Step 2: Get Customer Consent

Customers of the bank are required to

  1. Login to their ALAT profiles via the mobile application.

  2. Approve or reject request to access their transaction records using this API.

    • If customer approves, the requesting party is able to retrieve transaction data, either by calling the GetCustomerTransactions endpoint, or via an automated callback.

    • If customer rejects, access to records would be denied.

Step 3: GetCustomerTransactions

Request URL

POST - {baseURL}/get-statement-service/api/AccountMaintenance/GetCustomerTransactions

Try it out !

Requesting parties can query transactional data for approved requests using the referenceId for such requests.

A referenceId can only be used to query records from the initial request submitted.