Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.
Body
application/json
A type representing a range of time for filtering, including a mandatory start time and an optional end time.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BirrPay","colors":{"primary":"#4F8EFF","light":"#6BA3FF","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/birrpay/YnpImjYt65LKI-RI/logo/light.svg?fit=max\u0026auto=format\u0026n=YnpImjYt65LKI-RI\u0026q=85\u0026s=410fca5e1e3112fa410bfe0f1bc67731","dark":"https://mintcdn.com/birrpay/541dDB4gOfow0DxB/logo/dark.svg?fit=max\u0026auto=format\u0026n=541dDB4gOfow0DxB\u0026q=85\u0026s=e38313db04f8e480c019afc36f86deed"},"favicon":"/favicon.svg","api":{"openapi":["v1/openapi_spec_v1.json","v2/openapi_spec_v2.json","rust_locker_open_api_spec.yml"]},"background":{"color":{"light":"#FAFBFC","dark":"#1d1d1d"}},"navbar":{"links":[{"href":"https://birrpay.io/contactus","label":"Contact Us"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/birrpay-ethiopia"}},"integrations":{"gtm":{"tagId":"GTM-NQNN2JG5"},"mixpanel":{"projectToken":"b637c4588c180272bf586c5376e524e6"}},"contextual":{"options":["copy","claude","chatgpt","view"]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"birrpay","hasAudioNarration":false,"actualSubdomain":"birrpay","customDomains":["docs.birrpay.io"],"gitSource":{"type":"gitlab","owner":"birrpay","repo":"hyperswitch","projectId":77700133,"deployBranch":"develop","contentDirectory":"api-reference","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21eaf12fb2a99bab92c3fd","collectionId":"e126846c-3fdf-4d9b-8ab0-45d072d25e19","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21eaf12fb2a99bab92c3fd:success","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Documentation","count":183},{"language":"default","tag":"Payments Core APIs","count":53},{"language":"default","tag":"Other APIs","count":35},{"language":"default","tag":"Payments Core APIs [BETA]","count":32},{"language":"default","tag":"Account management APIs","count":28},{"language":"default","tag":"Account management APIs [BETA]","count":27},{"language":"default","tag":"Payments","count":26},{"language":"default","tag":"API Reference","count":24},{"language":"default","tag":"Routing","count":17},{"language":"default","tag":"Payment Methods","count":16}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v1/refunds/refunds--list","slug":"/v1/refunds/refunds--list","pageMetadata":{"openapi":"post /refunds/list","title":"Refunds - List","description":"Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided","href":"/v1/refunds/refunds--list","hidden":false},"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: \"Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided\"\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":{"openapi":"post /refunds/list","title":"Refunds - List","description":"Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided","href":"/v1/refunds/refunds--list","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Refunds"],"summary":"Refunds - List","description":"Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided","operationId":"List all Refunds","requestBody":"612aa109-f06d-4666-ad31-6ab953ab8660","responses":{"200":"4c8c2eb2-caaa-49c3-96e3-e52406af490e"},"security":["d43585c6-50d8-4826-b6cb-d47c1c757675"],"method":"post","type":"path","servers":["792875b0-3b61-48a0-ab23-731c1218999a"],"path":"/refunds/list","baseUrlOptions":["https://sandbox.birrpay.io"],"title":"Refunds - List","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"A type representing a range of time for filtering, including a mandatory start time and an optional end time.","required":["start_time"],"properties":{"start_time":{"type":"string","format":"date-time","description":"The start time to filter payments list or to get list of filters. To get list of filters start time is needed to be passed","isRequired":true,"uniqueKey":"start_time","typeLabel":"string\u003cdate-time>"},"end_time":{"oneOf":[{"type":"string","format":"date-time","description":"The end time to filter payments list or to get list of filters. If not passed the default time is now","uniqueKey":"end_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The end time to filter payments list or to get list of filters. If not passed the default time is now","uniqueKey":"end_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_time","typeLabel":"string\u003cdate-time> | null"},"payment_id":{"oneOf":[{"type":"string","description":"The identifier for the payment","uniqueKey":"payment_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The identifier for the payment","uniqueKey":"payment_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_id","typeLabel":"string | null"},"refund_id":{"oneOf":[{"type":"string","description":"The identifier for the refund","uniqueKey":"refund_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The identifier for the refund","uniqueKey":"refund_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund_id","typeLabel":"string | null"},"profile_id":{"oneOf":[{"type":"string","description":"The identifier for business profile","uniqueKey":"profile_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The identifier for business profile","uniqueKey":"profile_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"profile_id","typeLabel":"string | null"},"limit":{"oneOf":[{"type":"integer","format":"int64","description":"Limit on the number of objects to return","uniqueKey":"limit.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Limit on the number of objects to return","uniqueKey":"limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"limit","typeLabel":"integer\u003cint64> | null"},"offset":{"oneOf":[{"type":"integer","format":"int64","description":"The starting point within a list of objects","uniqueKey":"offset.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The starting point within a list of objects","uniqueKey":"offset.oneOf.1","typeLabel":"null"}],"uniqueKey":"offset","typeLabel":"integer\u003cint64> | null"},"amount_filter":{"oneOf":[{"type":"object","properties":{"start_amount":{"oneOf":[{"type":"integer","format":"int64","description":"The start amount to filter list of transactions which are greater than or equal to the start amount","uniqueKey":"amount_filter.oneOf.0.start_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The start amount to filter list of transactions which are greater than or equal to the start amount","uniqueKey":"amount_filter.oneOf.0.start_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_filter.oneOf.0.start_amount","typeLabel":"integer\u003cint64> | null"},"end_amount":{"oneOf":[{"type":"integer","format":"int64","description":"The end amount to filter list of transactions which are less than or equal to the end amount","uniqueKey":"amount_filter.oneOf.0.end_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The end amount to filter list of transactions which are less than or equal to the end amount","uniqueKey":"amount_filter.oneOf.0.end_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_filter.oneOf.0.end_amount","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"amount_filter.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"amount_filter.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_filter","typeLabel":"object | null"},"connector":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"connector.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The list of connectors to filter refunds list","uniqueKey":"connector.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The list of connectors to filter refunds list","uniqueKey":"connector.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector","typeLabel":"string[] | null"},"merchant_connector_id":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"merchant_connector_id.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The list of merchant connector ids to filter the refunds list for selected label","uniqueKey":"merchant_connector_id.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The list of merchant connector ids to filter the refunds list for selected label","uniqueKey":"merchant_connector_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_connector_id","typeLabel":"string[] | null"},"currency":{"oneOf":[{"type":"array","items":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"uniqueKey":"currency.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of currencies to filter refunds list","uniqueKey":"currency.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"]},"description":"The list of currencies to filter refunds list","uniqueKey":"currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency","typeLabel":"enum\u003cstring>[] | null"},"refund_status":{"oneOf":[{"type":"array","items":{"type":"string","description":"The status for refunds","enum":["succeeded","failed","pending","review"],"uniqueKey":"refund_status.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of refund statuses to filter refunds list","uniqueKey":"refund_status.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"type":"string","description":"The status for refunds","enum":["succeeded","failed","pending","review"]},"description":"The list of refund statuses to filter refunds list","uniqueKey":"refund_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"refund_status","typeLabel":"enum\u003cstring>[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"start_time":"2023-11-07T05:31:56Z","end_time":"2023-11-07T05:31:56Z","payment_id":"\u003cstring>","refund_id":"\u003cstring>","profile_id":"\u003cstring>","limit":123,"offset":123,"amount_filter":{"start_amount":123,"end_amount":123},"connector":["\u003cstring>"],"merchant_connector_id":["\u003cstring>"],"currency":[],"refund_status":[]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"4c8c2eb2-caaa-49c3-96e3-e52406af490e":{"description":"List of refunds","content":{"application/json":{"schema":{"type":"object","required":["count","total_count","data"],"properties":{"count":{"type":"integer","description":"The number of refunds included in the list","minimum":0,"isRequired":true,"uniqueKey":"count","typeLabel":"integer"},"total_count":{"type":"integer","format":"int64","description":"The total number of refunds in the list","isRequired":true,"uniqueKey":"total_count","typeLabel":"integer\u003cint64>"},"data":{"type":"array","items":{"type":"object","required":["refund_id","payment_id","amount","currency","status","connector"],"properties":{"refund_id":{"type":"string","description":"Unique Identifier for the refund","isRequired":true,"uniqueKey":"data.items.[INDEX].refund_id","typeLabel":"string"},"payment_id":{"type":"string","description":"The payment id against which refund is initiated","isRequired":true,"uniqueKey":"data.items.[INDEX].payment_id","typeLabel":"string"},"amount":{"type":"integer","format":"int64","description":"The refund amount, which should be less than or equal to the total payment amount. Amount for the payment in lowest denomination of the currency. (i.e) in cents for USD denomination, in paisa for INR denomination etc","example":6540,"minimum":100,"isRequired":true,"uniqueKey":"data.items.[INDEX].amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"The three-letter ISO currency code","isRequired":true,"uniqueKey":"data.items.[INDEX].currency","typeLabel":"string"},"status":{"type":"string","description":"The status for refunds","enum":["succeeded","failed","pending","review"],"isRequired":true,"uniqueKey":"data.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"connector":{"type":"string","description":"The connector used for the refund and the corresponding payment","example":"stripe","isRequired":true,"uniqueKey":"data.items.[INDEX].connector","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive","uniqueKey":"data.items.[INDEX].reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"An arbitrary string attached to the object. Often useful for displaying to users and your customer support executive","uniqueKey":"data.items.[INDEX].reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].reason","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","description":"You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object","uniqueKey":"data.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object","uniqueKey":"data.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].metadata","typeLabel":"object | null"},"error_message":{"oneOf":[{"type":"string","description":"The error message","uniqueKey":"data.items.[INDEX].error_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error message","uniqueKey":"data.items.[INDEX].error_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].error_message","typeLabel":"string | null"},"error_code":{"oneOf":[{"type":"string","description":"The code for the error","uniqueKey":"data.items.[INDEX].error_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code for the error","uniqueKey":"data.items.[INDEX].error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].error_code","typeLabel":"string | null"},"unified_code":{"oneOf":[{"type":"string","description":"Error code unified across the connectors is received here if there was an error while calling connector","uniqueKey":"data.items.[INDEX].unified_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Error code unified across the connectors is received here if there was an error while calling connector","uniqueKey":"data.items.[INDEX].unified_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].unified_code","typeLabel":"string | null"},"unified_message":{"oneOf":[{"type":"string","description":"Error message unified across the connectors is received here if there was an error while calling connector","uniqueKey":"data.items.[INDEX].unified_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Error message unified across the connectors is received here if there was an error while calling connector","uniqueKey":"data.items.[INDEX].unified_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].unified_message","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"The timestamp at which refund is created","uniqueKey":"data.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The timestamp at which refund is created","uniqueKey":"data.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"The timestamp at which refund is updated","uniqueKey":"data.items.[INDEX].updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The timestamp at which refund is updated","uniqueKey":"data.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time> | null"},"profile_id":{"oneOf":[{"type":"string","description":"The id of business profile for this refund","uniqueKey":"data.items.[INDEX].profile_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The id of business profile for this refund","uniqueKey":"data.items.[INDEX].profile_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].profile_id","typeLabel":"string | null"},"merchant_connector_id":{"oneOf":[{"type":"string","description":"The merchant_connector_id of the processor through which this payment went through","uniqueKey":"data.items.[INDEX].merchant_connector_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The merchant_connector_id of the processor through which this payment went through","uniqueKey":"data.items.[INDEX].merchant_connector_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].merchant_connector_id","typeLabel":"string | null"},"split_refunds":{"oneOf":[{"type":"object","description":"Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.","required":["stripe_split_refund"],"properties":{"stripe_split_refund":{"type":"object","description":"Charge specific fields for controlling the revert of funds from either platform or connected account for Stripe. Check sub-fields for more details.","properties":{"revert_platform_fee":{"oneOf":[{"type":"boolean","description":"Toggle for reverting the application fee that was collected for the payment.\nIf set to false, the funds are pulled from the destination account.","uniqueKey":"data.items.[INDEX].split_refunds.oneOf.0.stripe_split_refund.revert_platform_fee.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Toggle for reverting the application fee that was collected for the payment.\nIf set to false, the funds are pulled from the destination account.","uniqueKey":"data.items.[INDEX].split_refunds.oneOf.0.stripe_split_refund.revert_platform_fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.0.stripe_split_refund.revert_platform_fee","typeLabel":"boolean | null"},"revert_transfer":{"oneOf":[{"type":"boolean","description":"Toggle for reverting the transfer that was made during the charge.\nIf set to false, the funds are pulled from the main platform's account.","uniqueKey":"data.items.[INDEX].split_refunds.oneOf.0.stripe_split_refund.revert_transfer.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Toggle for reverting the transfer that was made during the charge.\nIf set to false, the funds are pulled from the main platform's account.","uniqueKey":"data.items.[INDEX].split_refunds.oneOf.0.stripe_split_refund.revert_transfer.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.0.stripe_split_refund.revert_transfer","typeLabel":"boolean | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.0.stripe_split_refund","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.0","typeLabel":"object"},{"type":"object","description":"Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.","required":["adyen_split_refund"],"properties":{"adyen_split_refund":{"type":"object","description":"Fee information for Split Payments to be charged on the payment being collected for Adyen","required":["split_items"],"properties":{"split_items":{"type":"array","items":{"type":"object","description":"Data for the split items","required":["amount","split_type","reference"],"properties":{"amount":{"type":"integer","format":"int64","description":"The amount of the split item","example":6540,"isRequired":true,"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.split_items.items.[INDEX].amount","typeLabel":"integer\u003cint64>"},"split_type":{"type":"string","enum":["BalanceAccount","AcquiringFees","PaymentFee","AdyenFees","AdyenCommission","AdyenMarkup","Interchange","SchemeFee","Commission","TopUp","Vat"],"isRequired":true,"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.split_items.items.[INDEX].split_type","typeLabel":"enum\u003cstring>"},"reference":{"type":"string","description":"Unique Identifier for the split item","isRequired":true,"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.split_items.items.[INDEX].reference","typeLabel":"string"},"account":{"oneOf":[{"type":"string","description":"The unique identifier of the account to which the split amount is allocated.","uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.split_items.items.[INDEX].account.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier of the account to which the split amount is allocated.","uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.split_items.items.[INDEX].account.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.split_items.items.[INDEX].account","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Description for the part of the payment that will be allocated to the specified account.","uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.split_items.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description for the part of the payment that will be allocated to the specified account.","uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.split_items.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.split_items.items.[INDEX].description","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.split_items.items.[INDEX]","typeLabel":"object"},"description":"Data for the split items","isRequired":true,"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.split_items","typeLabel":"object[]"},"store":{"oneOf":[{"type":"string","description":"The store identifier","uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.store.oneOf.0","typeLabel":"string"},{"type":"null","description":"The store identifier","uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.store.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund.store","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1.adyen_split_refund","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.1","typeLabel":"object"},{"type":"object","description":"Charge specific fields for controlling the revert of funds from either platform or connected account. Check sub-fields for more details.","required":["xendit_split_refund"],"properties":{"xendit_split_refund":{"type":"object","description":"Fee information to be charged on the payment being collected for sub-merchant via xendit","required":["for_user_id"],"properties":{"for_user_id":{"type":"string","description":"The sub-account user-id that you want to make this transaction for.","isRequired":true,"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.2.xendit_split_refund.for_user_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.2.xendit_split_refund","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].split_refunds.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"data.items.[INDEX].split_refunds.oneOf.3","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].split_refunds","typeLabel":"object · object · object · null"},"issuer_error_code":{"oneOf":[{"type":"string","description":"Error code received from the issuer in case of failed refunds","uniqueKey":"data.items.[INDEX].issuer_error_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Error code received from the issuer in case of failed refunds","uniqueKey":"data.items.[INDEX].issuer_error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].issuer_error_code","typeLabel":"string | null"},"issuer_error_message":{"oneOf":[{"type":"string","description":"Error message received from the issuer in case of failed refunds","uniqueKey":"data.items.[INDEX].issuer_error_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Error message received from the issuer in case of failed refunds","uniqueKey":"data.items.[INDEX].issuer_error_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].issuer_error_message","typeLabel":"string | null"},"raw_connector_response":{"oneOf":[{"type":"string","description":"Contains whole connector response","uniqueKey":"data.items.[INDEX].raw_connector_response.oneOf.0","typeLabel":"string"},{"type":"null","description":"Contains whole connector response","uniqueKey":"data.items.[INDEX].raw_connector_response.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].raw_connector_response","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"description":"The List of refund response object","isRequired":true,"uniqueKey":"data","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"count":1,"total_count":123,"data":[{"refund_id":"\u003cstring>","payment_id":"\u003cstring>","amount":6540,"currency":"\u003cstring>","status":"succeeded","connector":"stripe","reason":"\u003cstring>","metadata":{},"error_message":"\u003cstring>","error_code":"\u003cstring>","unified_code":"\u003cstring>","unified_message":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","profile_id":"\u003cstring>","merchant_connector_id":"\u003cstring>","split_refunds":{"stripe_split_refund":{"revert_platform_fee":true,"revert_transfer":true}},"issuer_error_code":"\u003cstring>","issuer_error_message":"\u003cstring>","raw_connector_response":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"d43585c6-50d8-4826-b6cb-d47c1c757675":{"api_key":{"type":"apiKey","in":"header","name":"api-key","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","scopes":[]}}},"servers":{"792875b0-3b61-48a0-ab23-731c1218999a":{"url":"https://sandbox.birrpay.io","description":"Sandbox Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api-key","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","scopes":[]},"schema":{"title":"api-key","type":"string","description":"Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"api-key"}],"title":"api_key"}]},"originalFileLocation":"v1/openapi_spec_v1.json"},"subdomain":"birrpay","siteName":"BirrPay","title":"Refunds - List - BirrPay","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/v1/refunds/refunds--list","matchLevel":0},"2.0.0 [BETA]":{"href":"/v2/refunds/refunds--list","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-01-24T02:55:16.188Z","originalFileLocation":"v1/refunds/refunds--list.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=\"Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided\">\u003cmeta data-mint-head name=\"application-name\" content=\"BirrPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_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/birrpay/UMKKiD5ajm4x882S/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Refunds - List - BirrPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BirrPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birrpay.io/v1/refunds/refunds--list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Refunds\u0026amp;title=Refunds+-+List\u0026amp;description=Lists+all+the+refunds+associated+with+the+merchant%2C+or+for+a+specific+payment+if+payment_id+is+provided\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=84c9562a2fab2344ad08b17a5e7d3f54035d672ae23e552f4e43cc40997e3474\">\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=\"Refunds - List - BirrPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Refunds\u0026amp;title=Refunds+-+List\u0026amp;description=Lists+all+the+refunds+associated+with+the+merchant%2C+or+for+a+specific+payment+if+payment_id+is+provided\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=84c9562a2fab2344ad08b17a5e7d3f54035d672ae23e552f4e43cc40997e3474\">\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/birrpay/UMKKiD5ajm4x882S/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BirrPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F8EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.birrpay.io/v1/refunds/refunds--list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v1/refunds/refunds--list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.birrpay.io/#organization\",\"name\":\"BirrPay\",\"url\":\"https://docs.birrpay.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/birrpay/YnpImjYt65LKI-RI/logo/light.svg?fit=max\u0026auto=format\u0026n=YnpImjYt65LKI-RI\u0026q=85\u0026s=410fca5e1e3112fa410bfe0f1bc67731\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.birrpay.io#website\",\"name\":\"BirrPay\",\"url\":\"https://docs.birrpay.io\",\"publisher\":{\"@id\":\"https://docs.birrpay.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.birrpay.io/v1/refunds/refunds--list#webpage\",\"url\":\"https://docs.birrpay.io/v1/refunds/refunds--list\",\"name\":\"Refunds - List\",\"description\":\"Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided\",\"dateModified\":\"2026-01-24T02:55:16.188Z\",\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birrpay.io/v1/refunds/refunds--list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birrpay.io/v1/refunds/refunds--list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments Core APIs\",\"item\":\"https://docs.birrpay.io/v1/payments/setup--instructions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Refunds\",\"item\":\"https://docs.birrpay.io/v1/refunds/refunds--create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Refunds - List\",\"item\":\"https://docs.birrpay.io/v1/refunds/refunds--list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birrpay.io/v1/refunds/refunds--list#apireference\",\"headline\":\"Refunds - List\",\"name\":\"Refunds - List\",\"description\":\"Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided\",\"url\":\"https://docs.birrpay.io/v1/refunds/refunds--list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birrpay.io/v1/refunds/refunds--list#webpage\"},\"dateModified\":\"2026-01-24T02:55:16.188Z\",\"publisher\":{\"@id\":\"https://docs.birrpay.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BirrPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"BirrPay","nav":{"global":null,"tabs":[{"tab":"Documentation","versions":[{"version":"1.0.0","groups":[{"group":"Get Started","pages":[{"title":"👋 Welcome to BirrPay API Reference","sidebarTitle":"Introduction","icon":"rectangle-code","iconType":"solid","href":"/introduction","hidden":false}]},{"group":"Essentials","pages":[{"title":"Authentication Types","href":"/essentials/authentication"},{"title":"Error Codes","href":"/essentials/error_codes"},{"title":"Rate Limits","href":"/essentials/rate_limit"},{"title":"Go-live Checklist","href":"/essentials/go-live"}]},{"group":"Payments Core APIs","pages":[{"sidebarTitle":"Setup Instructions","icon":"flag","iconType":"solid","title":null,"href":"/v1/payments/setup--instructions"},{"sidebarTitle":"Payment Flows","icon":"arrows-retweet","iconType":"solid","title":null,"href":"/v1/payments/payment--flows"},{"group":"Payments","pages":[{"openapi":"post /payments","title":"Payments - Create","href":"/v1/payments/payments--create"},{"openapi":"post /payments/{payment_id}","title":"Payments - Update","href":"/v1/payments/payments--update"},{"openapi":"post /payments/{payment_id}/confirm","title":"Payments - Confirm","href":"/v1/payments/payments--confirm"},{"openapi":"get /payments/{payment_id}","title":"Payments - Retrieve","href":"/v1/payments/payments--retrieve"},{"openapi":"post /payments/{payment_id}/cancel","title":"Payments - Cancel","href":"/v1/payments/payments--cancel"},{"openapi":"post /payments/{payment_id}/cancel_post_capture","title":"Payments - Cancel Post Capture","href":"/v1/payments/payments--cancel-post-capture"},{"openapi":"post /payments/{payment_id}/capture","title":"Payments - Capture","href":"/v1/payments/payments--capture"},{"openapi":"post /payments/{payment_id}/incremental_authorization","title":"Payments - Incremental Authorization","href":"/v1/payments/payments--incremental-authorization"},{"openapi":"post /payments/{payment_id}/extend_authorization","title":"Payments - Extended Authorization","href":"/v1/payments/payments--extend-authorization"},{"openapi":"post /payments/session_tokens","title":"Payments - Session token","href":"/v1/payments/payments--session-token"},{"openapi":"get /payment_link/{payment_link_id}","title":"Payments Link - Retrieve","href":"/v1/payments/payments-link--retrieve"},{"openapi":"get /payments/list","title":"Payments - List","href":"/v1/payments/payments--list"},{"openapi":"post /payments/{payment_id}/3ds/authentication","title":"Payments - External 3DS Authentication","href":"/v1/payments/payments--external-3ds-authentication"},{"openapi":"post /{payment_id}/complete_authorize","title":null,"href":"/v1/payments/payments--complete-authorize"},{"openapi":"post /payments/{payment_id}/update_metadata","title":"Payments - Update Metadata","href":"/v1/payments/payments--update-metadata"},{"openapi":"post /payments/{payment_id}/eligibility","title":"Payments - Submit Eligibility Data","href":"/v1/payments/payments--submit-eligibility-data"}]},{"group":"Payment Methods","pages":[{"openapi":"post /payment_methods","title":"PaymentMethods - Create","href":"/v1/payment-methods/paymentmethods--create"},{"openapi":"get /payment_methods/{method_id}","title":"Payment Method - Retrieve","href":"/v1/payment-methods/payment-method--retrieve"},{"openapi":"post /payment_methods/{method_id}/update","title":"Payment Method - Update","href":"/v1/payment-methods/payment-method--update"},{"openapi":"delete /payment_methods/{method_id}","title":"Payment Method - Delete","href":"/v1/payment-methods/payment-method--delete"},{"openapi":"post /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v1/payment-methods/payment-method--set-default-payment-method-for-customer"},{"openapi":"get /account/payment_methods","title":"List payment methods for a Merchant","href":"/v1/payment-methods/list-payment-methods-for-a-merchant"},{"openapi":"get /customers/payment_methods","title":"List customer saved payment methods for a Payment","href":"/v1/payment-methods/list-customer-saved-payment-methods-for-a-payment"},{"openapi":"get /customers/{customer_id}/payment_methods","title":"List payment methods for a Customer","href":"/v1/payment-methods/list-payment-methods-for-a-customer"},{"openapi":"post /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v1/customer-set-default-payment-method/customers--set-default-payment-method"}]},{"group":"Customers","pages":[{"openapi":"post /customers","title":"Customers - Create","href":"/v1/customers/customers--create"},{"openapi":"get /customers/{customer_id}","title":"Customers - Retrieve","href":"/v1/customers/customers--retrieve"},{"openapi":"post /customers/{customer_id}","title":"Customers - Update","href":"/v1/customers/customers--update"},{"openapi":"delete /customers/{customer_id}","title":"Customers - Delete","href":"/v1/customers/customers--delete"},{"openapi":"get /customers/list","title":"Customers - List","href":"/v1/customers/customers--list"}]},{"group":"Mandates","pages":[{"openapi":"post /mandates/revoke/{mandate_id}","title":"Mandates - Revoke Mandate","href":"/v1/mandates/mandates--revoke-mandate"},{"openapi":"get /mandates/{mandate_id}","title":"Mandates - Retrieve Mandate","href":"/v1/mandates/mandates--retrieve-mandate"},{"openapi":"post /customers/{customer_id}/mandates","title":null,"href":"/v1/mandates/mandates--customer-mandates-list"}]},{"group":"Refunds","pages":[{"openapi":"post /refunds","title":"Refunds - Create","href":"/v1/refunds/refunds--create"},{"openapi":"post /refunds/{refund_id}","title":"Refunds - Update","href":"/v1/refunds/refunds--update"},{"openapi":"get /refunds/{refund_id}","title":"Refunds - Retrieve","description":"Retrieves a Refund. This may be used to get the status of a previously initiated refund","href":"/v1/refunds/refunds--retrieve"},{"openapi":"post /refunds/list","title":"Refunds - List","href":"/v1/refunds/refunds--list"}]},{"group":"Disputes","pages":[{"openapi":"get /disputes/{dispute_id}","title":"Disputes - Retrieve Dispute","description":"Retrieves a dispute","href":"/v1/disputes/disputes--retrieve"},{"openapi":"get /disputes/list","title":"Disputes - List Disputes","href":"/v1/disputes/disputes--list"}]},{"group":"Authentication","pages":[{"openapi":"post /authentication","title":"Authentication - Create","href":"/v1/authentication/authentication--create"},{"openapi":"post /authentication/{authentication_id}/eligibility-check","title":"Authentication - POST Eligibility Check","href":"/v1/authentication/authentication--post-eligibility-check"},{"openapi":"get /authentication/{authentication_id}/eligibility-check","title":"Authentication - GET Eligibility Check","href":"/v1/authentication/authentication--get-eligibility-check"}]},{"group":"Payouts","pages":[{"openapi":"post /payouts/create","title":"Payouts - Create","href":"/v1/payouts/payouts--create"},{"openapi":"post /payouts/{payout_id}","title":"Payouts - Update","href":"/v1/payouts/payouts--update"},{"openapi":"post /payouts/{payout_id}/cancel","title":"Payouts - Cancel","href":"/v1/payouts/payouts--cancel"},{"openapi":"post /payouts/{payout_id}/fulfill","title":"Payouts - Fulfill","href":"/v1/payouts/payouts--fulfill"},{"openapi":"post /payouts/{payout_id}/confirm","title":"Payouts - Confirm","href":"/v1/payouts/payouts--confirm"},{"openapi":"get /payouts/{payout_id}","title":"Payouts - Retrieve","href":"/v1/payouts/payouts--retrieve"},{"openapi":"get /payouts/list","title":"Payouts - List","href":"/v1/payouts/payouts--list"},{"openapi":"post /payouts/filter","title":"Payouts - List available filters","href":"/v1/payouts/payouts--list-filters"},{"openapi":"post /payouts/list","title":"Payouts - List using filters","href":"/v1/payouts/payouts--filter"}]}]},{"group":"Account management APIs","pages":[{"group":"Organization","pages":[{"openapi":"post /organization","title":"Organization - Create","href":"/v1/organization/organization--create"},{"openapi":"get /organization/{id}","title":"Organization - Retrieve","href":"/v1/organization/organization--retrieve"},{"openapi":"put /organization/{id}","title":"Organization - Update","href":"/v1/organization/organization--update"}]},{"group":"Merchant Account","pages":[{"openapi":"post /accounts","title":"Merchant Account - Create","href":"/v1/merchant-account/merchant-account--create"},{"openapi":"get /accounts/{account_id}","title":"Merchant Account - Retrieve","href":"/v1/merchant-account/merchant-account--retrieve"},{"openapi":"post /accounts/{account_id}","title":"Merchant Account - Update","href":"/v1/merchant-account/merchant-account--update"},{"openapi":"delete /accounts/{account_id}","title":"Merchant Account - Delete","href":"/v1/merchant-account/merchant-account--delete"},{"openapi":"post /accounts/{account_id}/kv","title":"Merchant Account - KV Status","href":"/v1/merchant-account/merchant-account--kv-status"}]},{"group":"Business Profile","pages":[{"openapi":"post /account/{account_id}/business_profile","title":"Profile - Create","href":"/v1/business-profile/business-profile--create"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}","title":"Profile - Update","href":"/v1/business-profile/business-profile--update"},{"openapi":"get /account/{account_id}/business_profile/{profile_id}","title":"Profile - Retrieve","href":"/v1/business-profile/business-profile--retrieve"},{"openapi":"delete /account/{account_id}/business_profile/{profile_id}","title":"Profile - Delete","href":"/v1/business-profile/business-profile--delete"},{"openapi":"get /account/{account_id}/business_profile","title":"Profile - List","href":"/v1/business-profile/business-profile--list"}]},{"group":"Platform Account","pages":[{"openapi":"post /user/create_platform","title":"Platform - Create","href":"/v1/platform/platform--create"}]},{"group":"API Key","pages":[{"openapi":"post /api_keys/{merchant_id}","title":"API Key - Create","href":"/v1/api-key/api-key--create"},{"openapi":"get /api_keys/{merchant_id}/{key_id}","title":"API Key - Retrieve","href":"/v1/api-key/api-key--retrieve"},{"openapi":"post /api_keys/{merchant_id}/{key_id}","title":"API Key - Update","href":"/v1/api-key/api-key--update"},{"openapi":"delete /api_keys/{merchant_id}/{key_id}","title":"API Key - Revoke","href":"/v1/api-key/api-key--revoke"},{"openapi":"get /api_keys/{merchant_id}/list","title":"API Key - List","href":"/v1/api-key/api-key--list"}]},{"group":"Merchant Connector Account","pages":[{"openapi":"post /account/{account_id}/connectors","title":"Merchant Connector - Create","href":"/v1/merchant-connector-account/merchant-connector--create"},{"openapi":"get /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Retrieve","href":"/v1/merchant-connector-account/merchant-connector--retrieve"},{"openapi":"post /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Update","href":"/v1/merchant-connector-account/merchant-connector--update"},{"openapi":"delete /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Delete","href":"/v1/merchant-connector-account/merchant-connector--delete"},{"openapi":"get /account/{account_id}/connectors","title":"Merchant Connector - List","href":"/v1/merchant-connector-account/merchant-connector--list"}]},{"group":"GSM (Global Status Mapping)","pages":[{"openapi":"post /gsm","title":"Gsm - Create","href":"/v1/gsm/gsm--create"},{"openapi":"post /gsm/get","title":"Gsm - Get","href":"/v1/gsm/gsm--get"},{"openapi":"post /gsm/update","title":"Gsm - Update","href":"/v1/gsm/gsm--update"},{"openapi":"post /gsm/delete","title":"Gsm - Delete","href":"/v1/gsm/gsm--delete"}]}]},{"group":"Other APIs","pages":[{"group":"Event","pages":[{"openapi":"post /events/{merchant_id}","title":"Events - List","href":"/v1/event/events--list"},{"openapi":"get /events/{merchant_id}/{event_id}/attempts","title":"Events - Delivery Attempt List","href":"/v1/event/events--delivery-attempt-list"},{"openapi":"post /events/{merchant_id}/{event_id}/retry","title":"Events - Manual Retry","href":"/v1/event/events--manual-retry"}]},{"group":"Poll","pages":[{"openapi":"get /poll/status/{poll_id}","title":"Poll - Retrieve Poll Status","href":"/v1/poll/poll--retrieve-poll-status"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklist","title":null,"href":"/v1/blocklist/get-blocklist"},{"openapi":"post /blocklist","title":null,"href":"/v1/blocklist/post-blocklist"},{"openapi":"delete /blocklist","title":null,"href":"/v1/blocklist/delete-blocklist"},{"openapi":"post /blocklist/toggle","title":null,"href":"/v1/blocklist/post-blocklisttoggle"}]},{"group":"Routing","pages":[{"openapi":"get /routing","title":"Routing - List","href":"/v1/routing/routing--list"},{"openapi":"post /routing","title":"Routing - Create","href":"/v1/routing/routing--create"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}/dynamic_routing/success_based/create","title":"Routing - Auth Rate Based","href":"/v1/routing/routing--success-based"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}/dynamic_routing/elimination/create","title":"Routing - Elimination","href":"/v1/routing/routing--elimination"},{"openapi":"get /routing/active","title":"Routing - Retrieve Config","href":"/v1/routing/routing--retrieve-config"},{"openapi":"post /routing/deactivate","title":"Routing - Deactivate","href":"/v1/routing/routing--deactivate"},{"openapi":"get /routing/default","title":"Routing - Retrieve Default Config","href":"/v1/routing/routing--retrieve-default-config"},{"openapi":"post /routing/default","title":"Routing - Update Default Config","href":"/v1/routing/routing--update-default-config"},{"openapi":"get /routing/default/profile","title":"Routing - Retrieve Default For Profile","href":"/v1/routing/routing--retrieve-default-for-profile"},{"openapi":"post /routing/default/profile/{profile_id}","title":"Routing - Update Default For Profile","href":"/v1/routing/routing--update-default-for-profile"},{"openapi":"get /routing/{routing_algorithm_id}","title":"Routing - Retrieve","href":"/v1/routing/routing--retrieve"},{"openapi":"post /routing/{routing_algorithm_id}/activate","title":"Routing - Activate config","href":"/v1/routing/routing--activate-config"},{"openapi":"post /routing/evaluate","title":"Routing - Evaluate","href":"/v1/routing/routing--evaluate"},{"openapi":"post /routing/feedback","title":"Routing - Feedback","href":"/v1/routing/routing--feedback"},{"openapi":"post /routing/rule/evaluate","title":"Routing - Rule Evaluate","href":"/v1/routing/routing--rule-evaluate"}]},{"group":"Relay","pages":[{"openapi":"post /relay","title":"Relay - Create","href":"/v1/relay/relay"},{"openapi":"get /relay/{relay_id}","title":"Relay - Retrieve","href":"/v1/relay/relay--retrieve"}]},{"group":"Schemas","pages":[{"title":null,"href":"/v1/schemas/outgoing--webhook"}]},{"group":"Subscriptions","pages":[{"openapi":"post /subscriptions/create","title":"Subscription - Create","href":"/v1/subscriptions/create"},{"openapi":"post /subscriptions/{subscription_id}/confirm","title":"Subscription - Confirm","href":"/v1/subscriptions/confirm"},{"openapi":"post /subscriptions","title":"Subscription - Create and Confirm","href":"/v1/subscriptions/create-and-confirm"},{"openapi":"put /subscriptions/{subscription_id}/update","title":"Subscription - Update","href":"/v1/subscriptions/update"},{"openapi":"get /subscriptions/{subscription_id}","title":"Subscription - Retrieve","href":"/v1/subscriptions/get"},{"title":"Get plans","href":"/v1/subscriptions/get-plans"},{"openapi":"get /subscriptions/estimate","title":"Subscription - Get Estimate","href":"/v1/subscriptions/estimate"},{"openapi":"post /subscriptions/{subscription_id}/pause","title":"Subscription - Pause Subscription","href":"/v1/subscriptions/pause"},{"openapi":"post /subscriptions/{subscription_id}/resume","title":"Subscription - Resume Subscription","href":"/v1/subscriptions/resume"},{"openapi":"post /subscriptions/{subscription_id}/cancel","title":"Subscription - Cancel Subscription","href":"/v1/subscriptions/cancel"}]}]}]},{"version":"2.0.0 [BETA]","pages":[{"title":"2.0.0 [BETA]","href":"/v2/refunds/refunds--list"}]}]},{"tab":"Locker API Reference","pages":[{"title":"Locker API Reference","href":"/locker-api-reference/overview"}]},{"tab":"Intelligent Router API Reference","pages":[{"title":"Intelligent Router API Reference","href":"/intelligent-router-api-reference/overview"}]}]},"title":"Refunds - List - BirrPay","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}