Use this endpoint to retrieve settlement transactions — credits that have fully cleared and settled into your accounts. Unlike the general transactions list, this endpoint surfaces only confirmed inbound funds, making it the right tool for end-of-day reconciliation, settlement reporting, and verifying that expected payments have been received.
Endpoint POST https://baasapi.payrepmfb.com/api/v1/transaction/api/fetch_settlement_transactions
Authentication: Bearer token. Pass your JWT in the Authorization header as Bearer <access_token>. Obtain a token via Generate Token .Request Filter fields are nested under a filters object. Use start_date and end_date to scope settlement queries to specific reporting periods.
Body Parameters Optional object containing filter criteria for the settlement query. Restrict results to a specific account number (10-digit). Omit to retrieve settlements across all your accounts.
Return settlements on or after this date. Format: YYYY-MM-DD.
Return settlements on or before this date. Format: YYYY-MM-DD.
Filter to a single calendar day. Format: YYYY-MM-DD. Takes precedence over start_date/end_date when provided.
Filter by settlement status. Typically success for fully settled records.
Retrieve a specific settlement by its unique reference number.
Filter by payment channel, e.g., nip or intra.
Free-text search across settlement fields such as narration and reference number.
Page number for paginated results. Starts at 1.
Number of records to return per page. Minimum 1.
Maximum number of results to return. Minimum 1.
Cursor for cursor-based pagination. Pass the created_at timestamp of the last record from the previous page.
Cursor ID paired with cursor_created_at for stable cursor-based pagination.
Response A successful response returns the standard envelope with a paginated array of settlement records in data.
Response Fields true when the request succeeded.
"00" on success. See the error table below for other codes.
Human-readable status message.
Array of settlement transaction records. Unique reference identifier for this settlement. Use this for cross-system reconciliation.
The account number into which the settlement was credited.
The name of the account that received the settlement.
Settled amount in the base currency (e.g., "150000.00").
Will be credit for all settlement records — settlements represent confirmed inbound funds.
Category of the settlement, typically collection.
Settlement status. Expect success for cleared funds.
Payment channel used to originate the inflow (e.g., nip, intra).
Narration or description attached to the settlement.
ISO 8601 timestamp of when the settlement was recorded.
Example Request curl --request POST \ --url https://baasapi.payrepmfb.com/api/v1/transaction/api/fetch_settlement_transactions \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data '{ "filters": { "account_number": "7801234567", "start_date": "2026-04-01", "end_date": "2026-04-28" }, "page": 1, "page_size": 20 }'
Response { "status" : true , "response_code" : "00" , "message" : "Settlement transactions fetched successfully" , "data" : [ { "reference_number" : "SET-20260415-00456" , "account_number" : "7801234567" , "account_name" : "Lagos Branch Sales" , "amount" : "150000.00" , "transaction_type" : "credit" , "transaction_category" : "collection" , "status" : "success" , "channel" : "nip" , "remarks" : "Customer payment — Order #ORD-9981" , "created_at" : "2026-04-15T14:00:00Z" } ] }
Error Codes Response Code Meaning 00Success 41Customer not found — invalid API credentials 60Customer not active
