Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information.
GET
/
api
/
v1
/
SettlementFiles
List settlement files
curl --request GET \ --url https://financehub.paybyrd.com/api/v1/SettlementFiles \ --header 'x-api-key: <api-key>'
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Paybyrd","colors":{"primary":"#6319F0","light":"#A4ADFF","dark":"#6319F0"},"logo":{"light":"https://mintcdn.com/paybyrd/X3OHHz6EJVWhNTO3/images/logo-light-full.png?fit=max\u0026auto=format\u0026n=X3OHHz6EJVWhNTO3\u0026q=85\u0026s=35a8f83493759c89b1ee80db71265676","dark":"https://mintcdn.com/paybyrd/X3OHHz6EJVWhNTO3/images/logo-dark-full.png?fit=max\u0026auto=format\u0026n=X3OHHz6EJVWhNTO3\u0026q=85\u0026s=7d1a41429a1708ce79ff23f45f296959"},"favicon":"https://mintcdn.com/paybyrd/GOPy9l9hDJ70VNa1/images/Avatar-Square.png?fit=max\u0026auto=format\u0026n=GOPy9l9hDJ70VNa1\u0026q=85\u0026s=78f2ae4b46f5e013c30d747f9889aa80","background":{"color":{"light":"#f2f2f2","dark":"#2e2e2e"}},"navbar":{"links":[{"href":"https://www.paybyrd.com/","label":"Paybyrd"},{"href":"https://status.paybyrd.com/","label":"Status"}],"primary":{"type":"button","label":"Get started with Paybyrd","href":"https://backoffice.paybyrd.com/"}},"footer":{"socials":{"website":"https://www.paybyrd.com/"},"links":[{"header":"Mobile","items":[{"label":"Get the dashboard app","href":"/get-started/start-building"}]}]},"fonts":{"family":"DM Sans","weight":400,"source":"https://fonts.gstatic.com/s/dmsans/v17/rP2Yp2ywxg089UriI5-g7M8btVsD8Ck0q7u0-K6z8GXhnU0.woff2","format":"woff2"},"icons":{"library":"lucide"},"integrations":{"ga4":{"measurementId":"G-7PQTSPLP9K"}},"contextual":{"options":["copy","view","vscode","chatgpt","claude","mcp","add-mcp"],"display":"toc"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paybyrd","hasAudioNarration":false,"actualSubdomain":"paybyrd","customDomains":["docs.paybyrd.com"],"gitSource":{"type":"github","owner":"paybyrd","repo":"paybyrd-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfac3b1ec88bdf5ff40127","collectionId":"99135064-27cc-4e8f-a205-a81518acd153","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfac3b1ec88bdf5ff40127"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adfac3b1ec88bdf5ff40127","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":30},{"language":"default","tag":"Payments API","count":26},{"language":"default","tag":"Payments","count":23},{"language":"default","tag":"Integrations","count":14},{"language":"default","tag":"Accept Payments","count":13},{"language":"default","tag":"Get started","count":8},{"language":"default","tag":"Manage Payments","count":8},{"language":"default","tag":"Transactions","count":8},{"language":"default","tag":"Webhooks","count":8},{"language":"default","tag":"Point of Sale","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/settlement-files/list-settlement-files","slug":"/api-reference/settlement-files/list-settlement-files","pageMetadata":{"title":"List settlement files","description":"Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information.\n","deprecated":null,"version":null,"openapi":"/settlements-api.yml get /api/v1/SettlementFiles","href":"/api-reference/settlement-files/list-settlement-files","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List settlement files","description":"Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information.\n","deprecated":null,"version":null,"openapi":"/settlements-api.yml get /api/v1/SettlementFiles","href":"/api-reference/settlement-files/list-settlement-files","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listSettlementFiles","tags":["Settlement files"],"summary":"List settlement files","description":"Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information.\n","parameters":["8e749413-8ff1-4d0d-8f23-0e0c67f053e2","8e5e170f-25bd-4c7b-a817-0d2f64138435","f8d4da26-6fb9-4fa8-a331-b6189552d192","aa2e4013-2d20-4c81-8dfe-76e20ac13927"],"responses":{"200":"e83b1b97-5e61-4e92-9a92-041aa9c3b96f","400":"63ff7a48-7009-4daa-abdf-18a5eafdedc2","401":"231a66c1-f01d-402d-a22b-0532c5b2ed75","404":"9dce3024-031f-4cf7-bdab-cf0d02a13ece","500":"f4db2ce7-1f38-4d1a-8a2a-d27b59400832"},"method":"get","type":"path","servers":["39f79b6f-4c99-43bb-93e6-6207a1f1ab02"],"security":["03fed055-c513-45c7-b760-5ee8cc0c7992"],"path":"/api/v1/SettlementFiles","baseUrlOptions":["https://financehub.paybyrd.com"],"title":"List settlement files","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8e749413-8ff1-4d0d-8f23-0e0c67f053e2":{"name":"createdFrom","in":"query","required":true,"description":"Start of the time period (ISO 8601, UTC, no timezone offset). To retrieve a full day, set this to 00:00:00 of the target date.\n","schema":{"type":"string","format":"date-time","isRequired":true,"description":"Start of the time period (ISO 8601, UTC, no timezone offset). To retrieve a full day, set this to 00:00:00 of the target date.\n","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"example":"2022-11-18T00:00:00"},"8e5e170f-25bd-4c7b-a817-0d2f64138435":{"name":"createdTo","in":"query","required":true,"description":"End of the time period (ISO 8601, UTC, no timezone offset). To retrieve a full day, set this to 23:59:59 of the target date.\n","schema":{"type":"string","format":"date-time","isRequired":true,"description":"End of the time period (ISO 8601, UTC, no timezone offset). To retrieve a full day, set this to 23:59:59 of the target date.\n","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"example":"2022-11-18T23:59:59"},"f8d4da26-6fb9-4fa8-a331-b6189552d192":{"name":"merchantId","in":"query","required":false,"description":"Filter results to files for a specific merchant.","schema":{"type":"integer","format":"int64","isRequired":false,"description":"Filter results to files for a specific merchant.","uniqueKey":"","typeLabel":"integer\u003cint64>"}},"aa2e4013-2d20-4c81-8dfe-76e20ac13927":{"name":"storeId","in":"query","required":false,"description":"Filter results to files for a specific store.","schema":{"type":"integer","format":"int64","isRequired":false,"description":"Filter results to files for a specific store.","uniqueKey":"","typeLabel":"integer\u003cint64>"}}},"responses":{"e83b1b97-5e61-4e92-9a92-041aa9c3b96f":{"description":"A list of settlement files for the requested period.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","description":"A single settlement file entry returned in the list response.","required":["checksum","createdAt","groupId","id","url"],"properties":{"checksum":{"type":"string","description":"MD5 hash of the file contents, represented as a hexadecimal string.","example":"ba421754061547e5d80153d3d2923be4","isRequired":true,"uniqueKey":"data.items.[INDEX].checksum","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the file was generated (ISO 8601).","example":"2026-05-26T13:11:02.390069-03:00","isRequired":true,"uniqueKey":"data.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"groupId":{"type":"integer","format":"int64","description":"Customer-defined group or organization hierarchy.","example":1,"isRequired":true,"uniqueKey":"data.items.[INDEX].groupId","typeLabel":"integer\u003cint64>"},"id":{"type":"string","format":"uuid","description":"Unique identifier of the settlement file.","example":"59188227-0811-4e30-8c57-b8dff2ab07e9","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"url":{"type":"string","format":"uri","description":"Pre-signed URL to download the settlement CSV file. The URL is valid for 7 days from the time of the API request. To renew an expired URL, make a new request to this endpoint.\n","example":"https://financehubstoragestg.blob.core.windows.net/settlements-paybyrd/57/87/2026-05-26T16-11-00-4990180%2B0-PaybyrdSettlement.csv","isRequired":true,"uniqueKey":"data.items.[INDEX].url","typeLabel":"string\u003curi>"},"merchantId":{"type":"integer","format":"int64","description":"Customer-defined merchant identifier. When present, the file contains data scoped to this merchant and its stores. When absent, the file contains data for all merchants in the group.\n","example":1,"uniqueKey":"data.items.[INDEX].merchantId","typeLabel":"integer\u003cint64>"},"storeId":{"type":"integer","format":"int64","description":"Customer-facing merchant identification number. When present, the file contains data scoped to this specific store. When absent, the file contains data for all stores of the merchant (or all stores of the group if merchantId is also absent).\n","example":1,"uniqueKey":"data.items.[INDEX].storeId","typeLabel":"integer\u003cint64>"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"data":[{"checksum":"ba421754061547e5d80153d3d2923be4","createdAt":"2026-05-26T13:11:02.390069-03:00","groupId":1,"merchantId":1,"id":"59188227-0811-4e30-8c57-b8dff2ab07e9","url":"https://financehubstoragestg.blob.core.windows.net/settlements-paybyrd/57/87/2026-05-26T16-11-00-4990180%2B0-PaybyrdSettlement.csv"}]},"examples":{"Example":{"title":"Example","value":{"data":[{"checksum":"ba421754061547e5d80153d3d2923be4","createdAt":"2026-05-26T13:11:02.390069-03:00","groupId":1,"merchantId":1,"id":"59188227-0811-4e30-8c57-b8dff2ab07e9","url":"https://financehubstoragestg.blob.core.windows.net/settlements-paybyrd/57/87/2026-05-26T16-11-00-4990180%2B0-PaybyrdSettlement.csv"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"63ff7a48-7009-4daa-abdf-18a5eafdedc2":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"problemDetails":{"type":"object","required":["type","title","status","instance"],"properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"data.problemDetails.type","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"data.problemDetails.title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"data.problemDetails.status","typeLabel":"integer"},"instance":{"type":"string","isRequired":true,"uniqueKey":"data.problemDetails.instance","typeLabel":"string"},"extensions":{"type":"object","additionalProperties":true,"uniqueKey":"data.problemDetails.extensions","typeLabel":"object"}},"uniqueKey":"data.problemDetails","typeLabel":"object"},"contentType":{"type":"string","example":"application/problem+json","uniqueKey":"data.contentType","typeLabel":"string"},"statusCode":{"type":"integer","uniqueKey":"data.statusCode","typeLabel":"integer"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"data":{"problemDetails":{"type":"ApplicationBadRequestFail","title":"Bad request","status":400,"instance":"bad_request","extensions":{}},"contentType":"application/problem+json","statusCode":400}},"examples":{"Example":{"title":"Example","value":{"data":{"problemDetails":{"type":"ApplicationBadRequestFail","title":"Bad request","status":400,"instance":"bad_request","extensions":{}},"contentType":"application/problem+json","statusCode":400}}}},"exampleType":"examples"}},"exampleType":"examples"},"231a66c1-f01d-402d-a22b-0532c5b2ed75":{"description":"Missing or invalid API key.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9dce3024-031f-4cf7-bdab-cf0d02a13ece":{"description":"No settlement files found for the specified period.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"problemDetails":{"type":"object","required":["type","title","status","instance"],"properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"data.problemDetails.type","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"data.problemDetails.title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"data.problemDetails.status","typeLabel":"integer"},"instance":{"type":"string","isRequired":true,"uniqueKey":"data.problemDetails.instance","typeLabel":"string"},"extensions":{"type":"object","additionalProperties":true,"uniqueKey":"data.problemDetails.extensions","typeLabel":"object"}},"uniqueKey":"data.problemDetails","typeLabel":"object"},"contentType":{"type":"string","example":"application/problem+json","uniqueKey":"data.contentType","typeLabel":"string"},"statusCode":{"type":"integer","uniqueKey":"data.statusCode","typeLabel":"integer"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"data":{"problemDetails":{"type":"ApplicationNotFoundFail","title":"Settlement file not found with the specified period.","status":404,"instance":"not_found","extensions":{}},"contentType":"application/problem+json","statusCode":404}},"examples":{"Example":{"title":"Example","value":{"data":{"problemDetails":{"type":"ApplicationNotFoundFail","title":"Settlement file not found with the specified period.","status":404,"instance":"not_found","extensions":{}},"contentType":"application/problem+json","statusCode":404}}}},"exampleType":"examples"}},"exampleType":"examples"},"f4db2ce7-1f38-4d1a-8a2a-d27b59400832":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"problemDetails":{"type":"object","required":["type","title","status","instance"],"properties":{"type":{"type":"string","isRequired":true,"uniqueKey":"data.problemDetails.type","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"data.problemDetails.title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"data.problemDetails.status","typeLabel":"integer"},"instance":{"type":"string","isRequired":true,"uniqueKey":"data.problemDetails.instance","typeLabel":"string"},"extensions":{"type":"object","additionalProperties":true,"uniqueKey":"data.problemDetails.extensions","typeLabel":"object"}},"uniqueKey":"data.problemDetails","typeLabel":"object"},"contentType":{"type":"string","example":"application/problem+json","uniqueKey":"data.contentType","typeLabel":"string"},"statusCode":{"type":"integer","uniqueKey":"data.statusCode","typeLabel":"integer"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"data":{"problemDetails":{"type":"ApplicationServerErrorFail","title":"Internal server error","status":500,"instance":"server_error","extensions":{}},"contentType":"application/problem+json","statusCode":500}},"examples":{"Example":{"title":"Example","value":{"data":{"problemDetails":{"type":"ApplicationServerErrorFail","title":"Internal server error","status":500,"instance":"server_error","extensions":{}},"contentType":"application/problem+json","statusCode":500}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"03fed055-c513-45c7-b760-5ee8cc0c7992":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[]}}},"servers":{"39f79b6f-4c99-43bb-93e6-6207a1f1ab02":{"url":"https://financehub.paybyrd.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[]},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"settlements-api.yml"},"subdomain":"paybyrd","siteName":"Paybyrd","title":"List settlement files - Paybyrd","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-12T16:16:58.571Z","originalFileLocation":"api-reference/settlement-files/list-settlement-files.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paybyrd\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List settlement files - Paybyrd\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paybyrd\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paybyrd.com/api-reference/settlement-files/list-settlement-files\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paybyrd.mintlify.app/_mintlify/api/og/v2?division=Settlement+files\u0026amp;title=List+settlement+files\u0026amp;description=Returns+a+list+of+settlement+files+generated+within+the+specified+time+period.+Days+with+no+settlement+file+are+omitted+from+the+results.+When+more+than+one+fil\u0026amp;theme=482e40cfd6999bc2608c5e34\u0026amp;signature=06938a0ab4450dde3a30bbc8a3bbf7485c144c8871a4a1f82803c85b85ac1894\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List settlement files - Paybyrd\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paybyrd.mintlify.app/_mintlify/api/og/v2?division=Settlement+files\u0026amp;title=List+settlement+files\u0026amp;description=Returns+a+list+of+settlement+files+generated+within+the+specified+time+period.+Days+with+no+settlement+file+are+omitted+from+the+results.+When+more+than+one+fil\u0026amp;theme=482e40cfd6999bc2608c5e34\u0026amp;signature=06938a0ab4450dde3a30bbc8a3bbf7485c144c8871a4a1f82803c85b85ac1894\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/paybyrd/ZQOx_ixbIt0VLR4c/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paybyrd\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6319F0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paybyrd.com/api-reference/settlement-files/list-settlement-files\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/settlement-files/list-settlement-files.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paybyrd.com/#organization\",\"name\":\"Paybyrd\",\"url\":\"https://docs.paybyrd.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paybyrd/X3OHHz6EJVWhNTO3/images/logo-light-full.png?fit=max\u0026auto=format\u0026n=X3OHHz6EJVWhNTO3\u0026q=85\u0026s=35a8f83493759c89b1ee80db71265676\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paybyrd.com#website\",\"name\":\"Paybyrd\",\"url\":\"https://docs.paybyrd.com\",\"publisher\":{\"@id\":\"https://docs.paybyrd.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paybyrd.com/api-reference/settlement-files/list-settlement-files#webpage\",\"url\":\"https://docs.paybyrd.com/api-reference/settlement-files/list-settlement-files\",\"name\":\"List settlement files\",\"description\":\"Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information.\",\"dateModified\":\"2026-08-12T16:16:58.571Z\",\"isPartOf\":{\"@id\":\"https://docs.paybyrd.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paybyrd.com/api-reference/settlement-files/list-settlement-files#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paybyrd.com/api-reference/settlement-files/list-settlement-files#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Paybyrd\",\"item\":\"https://docs.paybyrd.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List settlement files\",\"item\":\"https://docs.paybyrd.com/api-reference/settlement-files/list-settlement-files\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paybyrd.com/api-reference/settlement-files/list-settlement-files#apireference\",\"headline\":\"List settlement files\",\"name\":\"List settlement files\",\"description\":\"Returns a list of settlement files generated within the specified time period. Days with no settlement file are omitted from the results. When more than one file exists for the same day, all files are complementary and must all be processed to obtain complete settlement information.\",\"url\":\"https://docs.paybyrd.com/api-reference/settlement-files/list-settlement-files\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paybyrd.com/api-reference/settlement-files/list-settlement-files#webpage\"},\"dateModified\":\"2026-08-12T16:16:58.571Z\",\"publisher\":{\"@id\":\"https://docs.paybyrd.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paybyrd.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paybyrd\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Paybyrd","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":"/introduction"}]},{"tab":"Payments","pages":[{"title":"Payments","href":"/accept-payments/how-it-works"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/embed/checkout"}]},{"tab":"API Reference","groups":[{"group":"API introduction","pages":[{"title":"API intro","href":"/api-reference/api-intro"},{"title":"Response code reference","href":"/api-reference/api-code-reference"},{"title":"Webhook API","href":"/api-reference/webhooks"}]},{"group":"Payments API","expanded":true,"pages":[{"group":"Payments","pages":[{"title":"Create Payment","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/payment","href":"/api-reference/payments/create-payment"},{"title":"Finish two-step card payment","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/payment/{transactionId}/pay","href":"/api-reference/payments/finish-two-step-card-payment"}]},{"group":"Transactions","pages":[{"title":"Refund","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/refund/{transactionId}","href":"/api-reference/transactions/refund"},{"title":"Release","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/release/{transactionId}","href":"/api-reference/transactions/release"},{"title":"Capture","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/capture/{transactionId}","href":"/api-reference/transactions/capture"},{"title":"Cancel","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/cancel/{transactionId}","href":"/api-reference/transactions/cancel"},{"title":"Adjust","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/adjust/{transactionId}","href":"/api-reference/transactions/adjust"},{"title":"Query","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/transactions/{transactionId}","href":"/api-reference/transactions/query"},{"title":"Receipt","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/transactions/{transactionId}/receipt","href":"/api-reference/transactions/receipt"},{"title":"Query by acquirer custom identifier","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/transactions?acquirerCustomId=${customIdentifier}","href":"/api-reference/transactions/query-by-acquirer-custom-identifier"}]},{"group":"Webhooks","pages":[{"title":"Setup URL","deprecated":true,"version":null,"openapi":"/openapi.yml put /api/v1/webhook","href":"/api-reference/webhooks/setup-url"},{"title":"Gets a webhook settings by its Id","deprecated":null,"version":null,"openapi":"/openapi.yml get /api/v2/webhooks/{webhookId}","href":"/api-reference/webhooks/gets-a-webhook-settings-by-its-id"},{"title":"Gets all webhook settings","deprecated":null,"version":null,"openapi":"/openapi.yml get /api/v2/webhooks","href":"/api-reference/webhooks/gets-all-webhook-settings"},{"title":"Creates a new webhook setting","deprecated":null,"version":null,"openapi":"/openapi.yml post /api/v2/webhooks","href":"/api-reference/webhooks/creates-a-new-webhook-setting"},{"title":"Updates a webhook setting url","deprecated":null,"version":null,"openapi":"/openapi.yml patch /api/v2/webhooks/{webhookId}/url","href":"/api-reference/webhooks/updates-a-webhook-setting-url"},{"title":"Enables a webhook setting","deprecated":null,"version":null,"openapi":"/openapi.yml post /api/v2/webhooks/{webhookId}/enable","href":"/api-reference/webhooks/enables-a-webhook-setting"},{"title":"Disables a webhook setting","deprecated":null,"version":null,"openapi":"/openapi.yml post /api/v2/webhooks/{webhookId}/disable","href":"/api-reference/webhooks/disables-a-webhook-setting"},{"title":"Updates a webhook setting url","deprecated":null,"version":null,"openapi":"/openapi.yml patch /api/v2/webhooks/{webhookId}/credentials","href":"/api-reference/webhooks/updates-a-webhook-setting-url-1"}]},{"group":"Paybylink","pages":[{"title":"resend","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/paybylink/{orderId}/resend","href":"/api-reference/paybylink/resend"}]},{"group":"Subscription","pages":[{"title":"Create","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/subscriptions","href":"/api-reference/subscription/create"}]},{"group":"Orders","pages":[{"title":"Create Order","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/orders","href":"/api-reference/orders/create-order"},{"title":"Query Order","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/orders/{orderId}","href":"/api-reference/orders/query-order"},{"title":"Cancel Order","deprecated":false,"version":null,"openapi":"/openapi.yml delete /api/v2/orders/{orderId}","href":"/api-reference/orders/cancel-order"}]},{"group":"Tokenization","pages":[{"title":"Get Token by reference","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/tokens","href":"/api-reference/tokenization/get-token-by-reference"},{"title":"Create Token","deprecated":false,"version":null,"openapi":"/openapi.yml post /api/v2/tokens","href":"/api-reference/tokenization/create-token"},{"title":"Get Token By Id","description":"Get a created token By Id","deprecated":false,"version":null,"openapi":"/openapi.yml get /api/v2/tokens/{tokenId}","href":"/api-reference/tokenization/get-token-by-id"}]}]},{"group":"Settlements API","pages":[{"group":"Settlement files","pages":[{"title":"List settlement files","deprecated":null,"version":null,"openapi":"/settlements-api.yml get /api/v1/SettlementFiles","href":"/api-reference/settlement-files/list-settlement-files"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"List settlement files - Paybyrd","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}