Transaction Settlement

Transaction settlements are the crucial final steps in ensuring the secure exchange of funds between parties using our payment platform. These settlements are completed by 12 am(midnight) after the day’s transactions.

Fetch settlements

Introduction

In this case, the request is to access and gather information about all settled transactions through the API.

Endpoint: GET - {{baseUrl}}/payment/settlement

Example Request

//A code snippet of how to consume the API

curl -X GET \
  {{baseUrl}}/v1/payment/settlement \
  -H "Accept: application/json" \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2RlbW8ubW9uaWNyZWRpdC5jb20vYXBpL3YxL2NvcmUvYXV0aC9sb2dpbiIsImlhdCI6MTY2ODk2NzQ0MywiZXhwIjoxNjY4OTcxMDQzLCJuYmYiOjE2Njg5Njc0NDMsImp0aSI6ImF0UE9GVHE4cU4yN2lBWlciLCJzdWIiOiJVU0FETUlOIiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyJ9.shrbQUV29vXRF30qMeBN3zxlc5JXd03QyMeD6ekzudU"

Response

{
    "status": true,
    "message": "Settlement Record Generated",
    "data": [
        {
            "id": "SET_000000000",
            "merchant_id": "MT0000000",
            "date_paid": null,
            "amount": "00000000",
            "status": "PENDING",
            "settlement_type": "revenue",
            "settlement_bank_id": "SB0000000",
            "settlement_batch": "SBATCH_0000000",
            "type": "REVENUE",
            "batch_reference": null,
            "settlement_bank": {
                "id": "SB000000",
                "name": "McClure-Lesch",
                "account_no": "000000",
                "account_name": "Wilmer Russel",
                "bank_code": null,
                "bank_name": "WEMA",
                "settlement_email": "[e-mail]"
            }
        }
    ]
}

Get Single Settlement

Introduction

In this case, the request is to access and gather information about a single settlement through the API.

Endpoint: GET - {{baseUrl}}/v1/payment/settlement

Parameter	Required	Description
settlementId	yes	string

Example Request

curl -X GET \
  '{{baseUrl}}/v1/payment/settlement/S62b132453ec1e?settlementId=S000000' \
  -H "Authorization: Bearer YOUR_BEARER_TOKEN"

Response

{
    "status": true,
    "message": "Settlement Retrieve successfully",
    "data": [
        {
            "id": "S000000000",
            "merchant_id": "MT000000",
            "date_paid": "2021-10-20 22:15:13",
            "amount": "00000",
            "status": "PAID",
            "settlement_type": "revenue",
            "settlement_bank_id": "SB0000000",
            "settlement_batch": null,
            "type": null,
            "batch_reference": null,
            "settlement_bank": {
                "id": "SB0000000",
                "name": "Stokes Nicolas and Kiehn",
                "account_no": "000000",
                "account_name": "Melyssa Kuhlman",
                "bank_code": null,
                "bank_name": "PROVIDUS",
                "settlement_email": "[e-mail]"
            }
        }
    ]
}