Register transactions

Register transactions

Payload

This is the payload required to register a transaction. If you have not gone through our guide on a quick set up to making requests, check here

{
    "customer_partner_id": "rYV43sJh57kTV58c",
    "sector": "Lender",
    "transactions": [
        {
            "client": {
                "first_name": "John",
                "last_name": "Doe",
                "contact_number": "08088090868",
                "id_type": "bvn",
                "id_value": 1234041101
            },
            "transaction_reference": "bf0c4ae7-877f-4233-af7d-b19c5be67581",
            "disbursement_date": "2022-01-03",
            "expected_payment_date": "2022-01-21",
            "reason": "Loan",
            "amount_payable": 350000,
            "financier": "Others"
        },
        {
            "client": {
                "first_name": "John",
                "last_name": "Doe",
                "contact_number": "08088090868",
                "id_type": "bvn",
                "id_value": 1234041101
            },
            "transaction_reference": "test-tester-gfgfgd-091601",
            "disbursement_date": "2022-09-08",
            "expected_payment_date": "2022-10-25",
            "reason": "Loan",
            "amount_payable": 200000,
            "financier": "B54"
        },
        {
            "client": {
                "business_name": "B54",
                "contact_number": "08088090868",
                "id_type": "rc_number",
                "id_value": 1234041101
            },
            "transaction_reference": "test-tester-gfgfgd-091602",
            "disbursement_date": "2022-07-13",
            "expected_payment_date": "2022-09-25",
            "reason": "Loan",
            "amount_payable": 100000,
            "financier": "Others",
            "meta": {
                "more_info": 123
            }
        }
    ],
    "financed_transactions": [
      {
            "transaction_reference": "bf0c4ae7-877f-4233-af7d-b19c5be67581",
            "amount": 300000,
        	  "drawdown_id": "NouBvjY2I1SeQ82b",
            "payments": [
                {
                    "disbursement_date": "2022-01-03",
                    "expected_payment_date": "2022-01-10",
                    "amount": 200000
                },
                {
                    "disbursement_date": "2022-01-10",
                    "expected_payment_date": "2022-01-21",
                    "amount": 150000
                }
            ]
        },
        {
            "transaction_reference": "test-tester-gfgfgd-091601",
            "amount": 190000,
            "drawdown_id": "NouBvjY2I1SeQ82b",
            "payments": [
                {
                    "disbursement_date": "2022-09-08",
                    "expected_payment_date": "2022-09-25",
                    "amount": 100000
                },
                {
                    "disbursement_date": "2022-09-25",
                    "expected_payment_date": "2022-10-25",
                    "amount": 100000
                }
            ]
        },
        {
            "transaction_reference": "test-tester-gfgfgd-091602",
             "drawdown_id": "NouBvjY2I1SeQ82b",
            "amount": 90000,
            "payments": [
                {
                    "disbursement_date": "2022-07-13",
                    "expected_payment_date": "2022-08-25",
                    "amount": 5000
                },
                {
                    "disbursement_date": "2022-08-25",
                    "expected_payment_date": "2022-09-25",
                    "amount": 5000
                }
            ]
        }
    ]
}

The `payload` object

Compulsory Fields

customer_partner_id _^array
A reference to your organisation on B54

sector _^string
Can be Lender, Aggregator, or Market Place

transactions _^array
This is an array of transactions.

client _^object
The identifier of the client on B54

first_name _^string
The First name of the client

last_name _^string
The Last name of the client

transaction_reference _^string
A reference identifier provided by the caller that is unique to each transaction

disbursement_date _^string
The date of the disbursement

expected_payment_date _^string
The expected payment date

amount_payable _^string
The amount expected to be received from the client

financier _^string
The financier of the transaction. Can be "B54" or "Others"

financed_transactions _^string
This list specifies more information about the each transaction in the transactions

transaction_reference _^string
A reference identifier provided by the caller that is unique to each transaction

amount _^string
The amount of financing being requested for the transaction

drawdown_id _^string
The reference to the drawdown on the B54

payments _^string
This list of installment payments for this transaction

disbursement_date _^string
The start date of this installment

expected_payment_date _^string
The expected amount for a particular installment

amount _^string
The amount for a particular installment

Optional Fields

client _^object
The identifier of the client on B54

contact_number _^string
The contact number of the client

id_type _^string
The ID type of the client

id_value _^string
The ID value for the client

reason _^string
A coarse categorization of the type of transaction that is helpful in presenting to capital partners

meta _^json
Any other information you would like to provide in a JSON format

Response

This is the expected response if the request is successful. Listen to your webhook, for the transaction's final status. See our webhooks

{
    "status": "success",
    "message": "Transaction registration in progress, check your dashboard in a few minutes",
    "data": []
}

Payload

The payload object

Compulsory Fields

Optional Fields

Response

The `payload` object