# List Settlements **GET /settlements** Returns a paginated list of settlements (bank deposits) for a given date or date range, based on the settlement (deposit) date. Each settlement summarizes one deposit to the merchant's bank account; retrieve its settled-transaction line items with [`GET /settlements/{settlementId}`](#operation-getsettlement). Either `date` or `fromDate`/`toDate` must be provided. The endpoint supports filtering and sorting via the `filters` and `sorts` parameters (see [List Transactions](#operation-gettransactions) for the filter operator table). #### Examples: - Single day: `?date=2026-07-01` - Date range, ACH only: `?fromDate=2026-07-01&toDate=2026-07-07&filters=type==Ach` - Largest first: `?date=2026-07-01&sorts=-amount` ## Servers - https://api.omni.integratedcommerce.io/v1: https://api.omni.integratedcommerce.io/v1 () ## Authentication methods - Api key header ## Parameters ### Query parameters - **date** (string(date)) A single day to report on. Either `date` or at least one of `fromDate`/`toDate` must be provided. When `date` is given it takes precedence and the range is that single day. Only the date part is used; any time component is ignored. - **fromDate** (string(date)) Inclusive start of the date range. If omitted while `toDate` is given, the range is the single day `toDate`. Only the date part is used; any time component is ignored. - **toDate** (string(date)) Inclusive end of the date range. If omitted while `fromDate` is given, the range is the single day `fromDate`. Only the date part is used; any time component is ignored. - **merchantIds** (string) Comma-separated list of merchant IDs to report on. Forward-compatible parameter for multi-merchant API keys; currently every ID must be the merchant resolved from the API key, and any other ID is rejected with `401`. Omit it to default to that merchant. - **filters** (string) Filter criteria in the format: field==value,field!=value Multiple filters can be separated by commas. Available fields: settlementDate, type, amount, status. netAmount is accepted as a deprecated alias of amount until it is removed. - **sorts** (string) Sort criteria as comma-separated field names. Prefix a field with `-` for descending order. Available fields: settlementDate, amount, status. netAmount is accepted as a deprecated alias of amount until it is removed. - **page** (integer) Page number to retrieve (starts at 1). For example, if you have 100 records with 10 per page, page 2 gives you records 11 to 20. - **pageSize** (integer) Number of records per page. For example, if you have 100 records with 10 per page, page 2 gives you records 11 to 20. ## Responses ### 200 A successful paginated response containing settlements #### Body: application/json (object) - **totalCount** (integer) Total number of settlements that match the filter criteria - **page** (integer) The current page number (starts at 1) - **pageSize** (integer) Number of items per page - **totalPages** (integer) Total number of pages available - **hasNextPage** (boolean) True if there are more pages of results available - **hasPreviousPage** (boolean) True if there are previous pages of results available - **items** (array[object]) Array of settlements for the current page ### 400 Bad request - no date parameters were provided. #### Body: application/json (object) - **code** (number) Numeric error code. These are grouped into ranges for easier identification and troubleshooting. * `0` - Unknown * `1000` - AuthenticationGenericError * `1001` - MerchantNotAuthorizedForResource * `2000` - RequestValidationGenericError * `2010` - InvalidPaymentMethodType - The payment method type is not supported for this operation. This includes: ACH tokens cannot be used for auth, void, or subscription transactions. * `2011` - InvalidTransactionType * `2012` - InvalidAmount * `2013` - PaymentMethodUsageRestricted * `2020` - InvalidPaymentMethodOwner * `2021` - InvalidAccountHolderOwner * `2100` - InvalidAccountHolderInformation * `2101` - InvalidCountryCode * `2102` - InvalidZipCode * `2103` - MissingCountryCodeOrZipCode * `2105` - InvalidEmailAddress * `2201` - MissingUniqueToken * `2202` - TransactionDeclinedError * `2900` - RequestValidationUnsupportedPayload * `2901` - RequestValidationWebhookMissingTypeAndDmnType * `2902` - RequestValidationUnsupportedWebhookTokenization * `2903` - RequestValidationUnsupportedWebhookType * `3000` - UnknownServerGenericError * `3201` - InvalidOrExpiredSession * `3202` - FailedToCreateSessionInAdapter * `3203` - ErrorWhileTokenizingCard * `3204` - FailedToLoadThirdPartySdk * `3205` - SessionExpired * `3299` - JavaScriptError * `3400` - ResourceNotReadyError * `3401` - TransactionNotCompleteYet * `3501` - CouldNotCreateBillingSubscription * `3502` - CouldNotCancelBillingSubscription * `3503` - BillingSubscriptionInvalidStatus * `4000` - ResourceNotFound * `4001` - TokenizedCardNotFound * `4002` - PaymentMethodNotFound * `4003` - AccountHolderNotFound * `4004` - BillingSubscriptionNotFound * `6000` - SdkGenericError * `6001` - SdkJavaScriptError * `6100` - SdkSessionLoadFailed * `6101` - SdkSessionExpired * `6102` - SdkSessionNotInitialized * `6103` - SdkEnvironmentMismatch * `6200` - SdkCardFieldsInvalid * `6201` - SdkCardTokenizationFailed * `6202` - SdkCardInitFailed * `6203` - SdkCardProcessingFailed * `6300` - SdkAchFieldsInvalid * `6301` - SdkAchProcessingFailed * `6400` - SdkEftProcessingFailed * `6500` - SdkWalletError * `6501` - SdkWalletProcessingFailed * `6600` - SdkThirdPartySdkLoadFailed * `6700` - SdkFormValidationFailed * `6701` - SdkBillingValidationFailed * `6800` - Sdk3dsAuthenticationFailed — Issuer ACS rejected the 3DS authentication. Only emitted when `formConfig.enable3DSecure: true`. * `6801` - Sdk3dsAuthenticationUnavailable — 3DS authentication could not be completed due to an upstream technical issue. * `6802` - Sdk3dsNotEnrolled — The card is not enrolled in 3DS. * `9000` - UnhandledGenericError * `9999` - MaxErrorCode - **status** (string) Execution status of the request sent to the payment gateway. * Completed - The request completed successfully. * Rejected - The request was rejected by the payment gateway. No action or side effects occurred. The transaction can safely be retried. * Interrupted - The request was interrupted, and the final status is unknown. Possible side effects may have occurred (e.g., a Sale (Token) that returns Interrupted might still charge the customer, even if an error is returned). Additional checks are required before retrying the transaction. * Unknown - **message** (string) Developer-facing error message. - **traceId** (string) Unique trace identifier for tracking and debugging this request. - **timestamp** (string(date-time)) The timestamp when the error occurred (UTC). - **errorDetails** (array[object]) Represents a validation error that occurred during the request. ### 401 Unauthorized response due to an invalid or missing API key. #### Body: application/json (object) - **code** (number) Numeric error code. These are grouped into ranges for easier identification and troubleshooting. * `0` - Unknown * `1000` - AuthenticationGenericError * `1001` - MerchantNotAuthorizedForResource * `2000` - RequestValidationGenericError * `2010` - InvalidPaymentMethodType - The payment method type is not supported for this operation. This includes: ACH tokens cannot be used for auth, void, or subscription transactions. * `2011` - InvalidTransactionType * `2012` - InvalidAmount * `2013` - PaymentMethodUsageRestricted * `2020` - InvalidPaymentMethodOwner * `2021` - InvalidAccountHolderOwner * `2100` - InvalidAccountHolderInformation * `2101` - InvalidCountryCode * `2102` - InvalidZipCode * `2103` - MissingCountryCodeOrZipCode * `2105` - InvalidEmailAddress * `2201` - MissingUniqueToken * `2202` - TransactionDeclinedError * `2900` - RequestValidationUnsupportedPayload * `2901` - RequestValidationWebhookMissingTypeAndDmnType * `2902` - RequestValidationUnsupportedWebhookTokenization * `2903` - RequestValidationUnsupportedWebhookType * `3000` - UnknownServerGenericError * `3201` - InvalidOrExpiredSession * `3202` - FailedToCreateSessionInAdapter * `3203` - ErrorWhileTokenizingCard * `3204` - FailedToLoadThirdPartySdk * `3205` - SessionExpired * `3299` - JavaScriptError * `3400` - ResourceNotReadyError * `3401` - TransactionNotCompleteYet * `3501` - CouldNotCreateBillingSubscription * `3502` - CouldNotCancelBillingSubscription * `3503` - BillingSubscriptionInvalidStatus * `4000` - ResourceNotFound * `4001` - TokenizedCardNotFound * `4002` - PaymentMethodNotFound * `4003` - AccountHolderNotFound * `4004` - BillingSubscriptionNotFound * `6000` - SdkGenericError * `6001` - SdkJavaScriptError * `6100` - SdkSessionLoadFailed * `6101` - SdkSessionExpired * `6102` - SdkSessionNotInitialized * `6103` - SdkEnvironmentMismatch * `6200` - SdkCardFieldsInvalid * `6201` - SdkCardTokenizationFailed * `6202` - SdkCardInitFailed * `6203` - SdkCardProcessingFailed * `6300` - SdkAchFieldsInvalid * `6301` - SdkAchProcessingFailed * `6400` - SdkEftProcessingFailed * `6500` - SdkWalletError * `6501` - SdkWalletProcessingFailed * `6600` - SdkThirdPartySdkLoadFailed * `6700` - SdkFormValidationFailed * `6701` - SdkBillingValidationFailed * `6800` - Sdk3dsAuthenticationFailed — Issuer ACS rejected the 3DS authentication. Only emitted when `formConfig.enable3DSecure: true`. * `6801` - Sdk3dsAuthenticationUnavailable — 3DS authentication could not be completed due to an upstream technical issue. * `6802` - Sdk3dsNotEnrolled — The card is not enrolled in 3DS. * `9000` - UnhandledGenericError * `9999` - MaxErrorCode - **status** (string) Execution status of the request sent to the payment gateway. * Completed - The request completed successfully. * Rejected - The request was rejected by the payment gateway. No action or side effects occurred. The transaction can safely be retried. * Interrupted - The request was interrupted, and the final status is unknown. Possible side effects may have occurred (e.g., a Sale (Token) that returns Interrupted might still charge the customer, even if an error is returned). Additional checks are required before retrying the transaction. * Unknown - **message** (string) Developer-facing error message. - **traceId** (string) Unique trace identifier for tracking and debugging this request. - **timestamp** (string(date-time)) The timestamp when the error occurred (UTC). - **errorDetails** (array[object]) Represents a validation error that occurred during the request. [Powered by Bump.sh](https://bump.sh)