Get Card Settlements

Use this API to retrieve a list of settlements for a specific card. A settlement represents a finalized card transaction where funds have been officially transferred from the cardholder's account to the merchant's account.

Each settlement record includes:

  • Transaction amount — the total value of the settled transaction
  • Transaction dates — when the transaction was processed and settled
  • Merchant information — the merchant's name and location
  • Settlement status — the outcome of the settlement (e.g., COMPLETED, REJECTED)

Use the available query parameters to filter and paginate results:

  • startDate / endDate — Narrow results to a specific date range. Use dateFormat to specify the date format (e.g., dd mm yyyy).
  • status — Filter settlements by status, such as COMPLETED or REJECTED.
  • internalClearingId — Look up a specific settlement by its internal clearing identifier.
  • isCardSettlementOnly — Set to true to return only card settlements, excluding other settlement types. Defaults to false.
  • offset and limit — Control pagination. Defaults to 0 and 15 respectively.
  • orderBy and sortOrder — Sort results by created_at in asc or desc order. Defaults to desc.

A successful response returns a paginated list of card settlements matching the specified filters.

Query Params
string

The start date from which to fetch all settlements. The format should be consistent with the specified dateFormat.
Example: 10 May 2024

string

The end date up to which to fetch all settlements. The format should be consistent with the specified dateFormat.
Example: 10 June 2024

string

The format of the dates provided in startDate and endDate. Common formats include dd/mm/yyyy or yyyy-mm-dd.
Example: dd mm yyyy

integer

The number of records to skip before starting to fetch the results. Useful for pagination.
The default value is '0'.
Example: 0

integer

The maximum number of settlements to return in the response. Useful for limiting the size of the result set.
The default value is '15'.
Example: 15

string

The status of the settlements to fetch. Possible statuses may include COMPLETED,REJECTED, etc.
Example: COMPLETED

string

The internal clearing ID used to uniquely identify a specific settlement for internal tracking purposes.
Example: #999900522833#2941#1014212312#VSA

string

In which order you want to fetch. The default value is 'created_at'.
Example: created_at

string
Defaults to desc

The order in which to sort the results. Can be asc for ascending or desc for descending. The default value is desc.
example: desc

boolean

Flag to indicate if only card settlements should be fetched. Set to true to filter out non-card settlements.
The default value is false.
example: false

Headers
string
required

The ID of your banking instance visible in the MBANQ Console.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json