Submission / Upload

# Request Parameters

The following parameters are expected:

Field Description Type
document_type The type of statement to be processed. Supported: MOMO, BANK, String
organization_code This is an identifier for the organization. This will be provided by the Spin Mobile Team String
bank_code An identifier for the specific bank. Example ABSA, NCBA, CENTENARY, DTB. Refer below for the full list. String
sender An identifier for the mode of submission. Example LMS_API, email@spinmobile.co. String
decrypter E-Statement password. Send blank if the file is not encrypted. Example 123456 String
remote_identifier An external reference to help identify the customer while submitting data to the client system. Example ID Number String

Please find sample implementation on the left


# Supported Banks

The following are the supported banks:

Bank / MFB Code
Centenary Bank CENTENARY
DTB Bank DTB
NCBA Bank NCBA
ABSA Bank ABSA

Please Note: The list of supported is always changing as new banks are incorporated. To check the latest added banks log into the system, go to Banks Menu and click on Upload Statement

# Supported Document Types

The following are the supported banks:

E-Statement Document Type
MOMO Statement MOMO
Bank Statement BANK
Airtel statements MOMO
MTN Statements MOMO

# Response

E-statement submission is an asynchronous process where the statement is submitted first, then the results are sent back to the client through a webhook. On submission, below is a sample response

Description

Field DataType Description
code String A success or failure error code.
message String A description of the results.
data dict On a successful submission, a dictionary is returned with the statements unique id. This unique id can be used to query the statement status or analysis later on.

API format

This is the data format submitted to third-party endpoint

{
  "code": "100.000.000",
  "message": "Upload successful",
  "data": { "id": "some-text" }
}