Collect/Update Transactios

This endpoint allows developers to pass customer's transactions for it to be processed. The transactions will be sent alongside the account details.

πŸ“˜

NOTE

For new accounts, you will post the transactions to get an account ID. To update the transactions, you can use the put request.

COLLECT TRANSACTIONS

Request

{{baseUrl}}/api/v1/financial/transactions

Headers

Parameter

Type

Description

AppId

string

you would need to create an app to get your app ID

Authorization

string

public secret key e.g prod_sk_1T1eSavlZxy02OT3OWlvbxK4G

Body Parameters

Parameter

Type

Description

transactions

array

[
{ "transaction_date": "2021-04-30",
"transaction_type": "credit",
"transaction_amount": "2016.4",
"reference_number": "12345tgfnde", "transaction_description": "0033199479:Int.Pd:01-04-2021 to 30-04-2 |" },
{ "transaction_date": "2021-05-30",
"transaction_type": "credit",
"transaction_amount": "2016.4",
"reference_number": "12345tgfnde", "transaction_description": "0033199479:Int.Pd:01-04-2021 to 30-04-2 |" }, ...
]

Response Sample

{
    "message": "Account Created Successfully",
    "entity": {
        "account_id": "7364e849-66ee-46a3-a5b5-5d7ed626b835"
    }
}

UPDATE TRANSACTIONS

Request

{{baseUrl}}/api/v1/financial/transactions/{{account_id}}

Body Parameters

Parameter

Type

Description

transactions

array

an array of transactions

Response Sample

{
    "message": "Account Updated Successfully"
}

Did this page help you?