Settlements

Transaction Settlement API

Environment Urls

Sandbox: https://devbox.paydestal.com/settlement
Prod:    https://api.paydestal.com/settlement

GET Settlement List

curl --location 'https://devbox.paydestal.com/settlement/api/v1/settlements' \
--header 'Authorization: Bearer {your client secret key}'

Request Params

  curl --location 'https://devbox.paydestal.com/settlement/api/v1/settlements?clearanceStartDate=2024-06-01&clearanceEndDate=2024-06-23' \
  --header 'Authorization: Bearer {your client secret key}' 

Name	Type	Description
clearanceStartDate	Date	Format: YYYY-MM-DD e.g 2024-06-19
clearanceEndDate	Date	Format: YYYY-MM-DD e.g 2024-06-20
reference	String	Merchant Reference or Paydestal Reference
page	Int	e.g page=1
pageSize	Int	e.g pageSize=30

GET List Settlement in Settlement Batch Get all settled transactions by settlement batch reference API

curl --location 'https://devbox.paydestal.com/settlement/api/v1/list-transactions-in-batch/{batchReference}' \
--header 'Authorization: Bearer {your client secret key}' 

{
    "responseCode": "200",
    "responseMessage": "Successful",
    "data": {
        "content": [
            {
                "id": "7cdbf9a1-35aa-4d60-ae66-9ef7f0078b41",
                "amount": 500.0,
                "amountPaid": 500.0,
                "fee": 7.5,
                "accountNumber": "4701735101",
                "channel": "BANKTRANSFER",
                "reference": "00000fd400d4-3c28-42eb-bd8e-e51b52c95536",
                "paydestalReference": "PYDN-20240620034034-1573514476172",
                "settlementBatchReference": "PYND-STTL-545761548840-20062024-060001",
                "currency": "NGN",
                "paymentStatus": "SUCCESSFUL",
                "created": "2024-06-20T04:35:08.633+00:00"
            },
            {
                "id": "61349528-cffc-4918-9fc7-b0e73f4fd879",
                "amount": 500.0,
                "amountPaid": 500.0,
                "fee": 7.5,
                "accountNumber": "4701637872",
                "channel": "BANKTRANSFER",
                "reference": "00007c596fdd-c9d0-4c40-bed6-d577ed686edf",
                "paydestalReference": "PYDN-20240612144625-1638841311335",
                "settlementBatchReference": "PYND-STTL-545761548840-20062024-060001",
                "currency": "NGN",
                "paymentStatus": "SUCCESSFUL",
                "created": "2024-06-20T04:35:12.119+00:00"
            },
            {
                "id": "e7fa2835-f6af-4072-b582-d474a42188b9",
                "amount": 3000.0,
                "amountPaid": 3000.0,
                "fee": 45.0,
                "accountNumber": "4701634637",
                "channel": "BANKTRANSFER",
                "reference": "0000b8055cc3-0d2f-45c8-89e6-91b84b72441b",
                "paydestalReference": "PYDN-20240611144946-4122444847353",
                "settlementBatchReference": "PYND-STTL-545761548840-20062024-060001",
                "currency": "NGN",
                "paymentStatus": "SUCCESSFUL",
                "created": "2024-06-20T04:35:14.276+00:00"
            }
        ],
        "pageable": {
            "pageNumber": 0,
            "pageSize": 50,
            "sort": {
                "empty": true,
                "unsorted": true,
                "sorted": false
            },
            "offset": 0,
            "paged": true,
            "unpaged": false
        },
        "totalPages": 1,
        "totalElements": 3,
        "last": true,
        "size": 50,
        "number": 0,
        "sort": {
            "empty": true,
            "unsorted": true,
            "sorted": false
        },
        "numberOfElements": 3,
        "first": true,
        "empty": false
    },
    "success": true
}