Links
📳

USSD Statement

Allow Customers to leverage existing USSD infrastructure to digitize bank statements. Retrieving bank statements for processing, categorizing and storing transactional and account data.
Using the Customers mobile number that is registered to their bank account, a Customer can send their bank statements to our Gathr USSD service.
post
{{baseUrl}}/bank-accounts/:bank_account_id/ussd
USSD Statement Collection
As this is a specific post query, we need to make sure we are sending customer/clients to a safe destination, as such, there is validation done on the Redirect and Webhook URL.
The Filed under validation must have a valid A or AAAA record when querying the dns_get_record PHP function.
A a simple guideline:
  • Must be RFC compliant
  • Must include the hostname
  • Be careful with special characters that might mess with the structure of the post request
Example Payload
{
"id":"{{bankAccountId}}",
"customer_id":"{{customerId}}",
"type":"ussd",
"bank":"capitec",
"accounts":[
{
"id":"cf81d2d9-761e-4dd4-be27-a9451d9a51bc",
"accountNumber":"1974423784",
"accountName":"Savings Account",
"accountBalance":"2,489.71",
"accountHolder":"MR CHRISTOPHER JAMES PATRICK BALL",
"accountAddress":"Unit 22 Eton Park 6Eton Road Sandhurst Johannesburg",
"transactions":[
{
"id":"ffed84c1-2dab-43d8-9259-73225053b0bf",
"type":"debit",
"amount":160,
"description":"Lotto Payment (OCIT94210639)",
"date":"2023-03-23T00:00:00",
"balance":7178.33,
"category":"Expenses",
"category_slug":"expenses",
"category_type":null
},
{
"id":"e3b2e1c8-e151-4487-8d2d-71e45f1e9c4f",
"type":"credit",
"amount":3000,
"description":"Payment Received Mb Capitec Salary",
"date":"2023-03-25T00:00:00",
"balance":10026.33,
"category":"Salary & Wages",
"category_slug":"salary-wages",
"category_type":null
},
{
"id":"4a009f33-a9c2-4db7-8653-8c9acc1ffe02",
"type":"debit",
"amount":1109,
"description":"Eft Debit Order (0922216357): Mtn Sp (BA112008273)",
"date":"2023-03-25T00:00:00",
"balance":5916.33,
"category":"Debt",
"category_slug":"debt",
"category_type":null
},
{
"id":"2ea2282e-2ed9-46b7-ae48-9c2bf93a016a",
"type":"credit",
"amount":5,
"description":"Daily Lotto Winnings (HIJJ43096893)",
"date":"2023-03-28T00:00:00",
"balance":5917.83,
"category":"Income",
"category_slug":"income",
"category_type":null
},
{
"id":"68101b58-9f82-44c0-b901-6a0cd2204eb7",
"type":"credit",
"amount":9.8,
"description":"Daily Lotto Winnings (HIJJ43096893)",
"date":"2023-03-29T00:00:00",
"balance":5874.13,
"category":"Income",
"category_slug":"income",
"category_type":null
}
]
}
],
"statements":[
{
"id":"ad10b2ad-5994-40b3-98c9-7b813ac0e77d",
"bank_account_id":"65fd8386-c76f-4811-b54b-e208f1f34cc6",
"statement_date":"2023-07-13",
"start_date":"2023-03-15",
"end_date":"2023-07-13",
"temp_url":"https://fincheck-onboarding.s3.eu-west-1.amazonaws.com/testing/client_73a11991-b80b-42fb-a6e2-ee19d477fcd1/statements/test/65fd8386-c76f-4811-b54b-e208f1f34cc6/bank_account/CapitecBankStatement_15032023-13072023%20%282%29.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAQOIKJL7BXFF7LDWP%2F20230719%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20230719T102927Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Signature=c12cddc21f815445d857973b7dfc6ab039628293d9bda4f808a1d6e55f3e6ac4",
"expires_in":"60m",
"file":{
"id":1354,
"name":"CapitecBankStatement_15032023-13072023 (2).pdf",
"type":"pdf",
"url":"http://http:/fincheck/documents/CapitecBankStatement_15032023-13072023%20%282%29.pdf"
},
"transaction_count":46,
"month":"Mar 2023",
"fraud":{
"fraud_checks":{
"statement_balance":false,
"create_date":false,
"meta_mod_date":"not applicable",
"meta_producer":"not applicable",
"meta_creator":false,
"meta_author":false
}
},
"processed":true
}
]
}
Last modified 6mo ago