Skip to main content
POST
/
v1
/
settlement
/
run
Manually trigger a settlement run
curl --request POST \
  --url https://idaas.yourflexpay.com/api/v1/settlement/run \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "errorCode": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settlementDate": "2025-03-03",
    "currency": "NGN",
    "totalCredited": 250000,
    "totalDebited": 250000,
    "transactionCount": 123,
    "applicationCount": 123,
    "status": "PENDING",
    "errorMessage": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "entries": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "applicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "applicationName": "WalletApp",
        "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "currency": "NGN",
        "totalCredited": 150000,
        "totalDebited": 100000,
        "netAmount": 50000,
        "openingBalance": 123,
        "closingBalance": 123,
        "transactionCount": 123,
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "errors": [
    "<string>"
  ],
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Obtain a token from POST /v1/auth/token using your client_id and client_secret, then enter Bearer <token> here.

Query Parameters

​
date
string<date>

Date to settle (ISO-8601 format, e.g. 2025-03-03). Defaults to yesterday UTC if omitted.

Response

Settlement run completed (or already completed for this date)

​
success
boolean
​
message
string
​
errorCode
string
​
data
object

End-of-day settlement batch aggregating all completed transaction movements

​
errors
string[]
​
timestamp
string<date-time>