Generate Statements

Periodic Account Statement

POST /statement/applyAccountStatement

Use this endpoint to request for an account statement.

How it works: You submit the request to generate a particular account's statement, our BaaS system will schedules a job to generate it which takes at most 15 minutes to complete.

When the job is done, callback notification 0009 is sent to you which contains the URL for downloading the account statement file.

circle-info

Maximum duration of records you can query for is 180 days

Parameters
Type
Description
Is Required

accountId

string

Account number of the SME or merchant account

TRUE

startTime

long

Unix timestamp of the start time of the queried period

TRUE

endTime

long

Unix timestamp of the end time of the queried period

TRUE

fileType

string

pdf

xlsx

FALSE

Response

{
  "jobId": "", //String, account statement generation job id.
}

Query Account Statement Job Status

POST /statement/queryAccountStatement

This endpoint allows end users to query account statement job status Parameters

Parameters
Type
Description
Is Required

jobId

string

account statement job Id

TRUE

Response

Customer Bank Statement Request (to email)

POST /statement/applyBankAccountStatement

Customers request the bank account statement (for now, available in Excel form only) for a period, and the statement will be generated asynchronously and encryptedly sent to the owner's/account manager's email.

circle-info

An account can only request a max of 10 times in a day Password is last 6 digits of the owner of the account's mobile number The statement link contained in the email body expires in 7 days

Parameters

Parameters
Type
Description
Required?

accountId

string

The number of the account

TRUE

startTime

long

(UNIX timestamp)

TRUE

endTime

long

(UNIX timestamp). Not more than 180 days.

TRUE

email

string

The email address of the account owner or account manager, with or without verification.

TRUE

fileType

string

pdf or xlsx

FALSE

Response

Query Customer Statement Request (to email) Application Status

POST /statement/queryBankAccountStatement

Use this to check the status of the bank account statement application status.

circle-info

An account can only request a max of 10 times in a day Password is last 6 digits of the owner of the account's mobile number The statement link contained in the email body expires in 7 days

Parameters

Parameters
Type
Description
Is Required

jobId

string

account statement job Id

TRUE

Response

Last updated