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":"v2/refunds/refunds--list","slug":"/v2/refunds/refunds--list","pageMetadata":{"openapi":"post /v2/refunds/list","title":"Refunds - List","description":"To list the refunds associated with a payment_id or with the merchant, if payment_id is not provided","href":"/v2/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: \"To list the refunds associated with a payment_id or with the merchant, if payment_id is not 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 /v2/refunds/list","title":"Refunds - List","description":"To list the refunds associated with a payment_id or with the merchant, if payment_id is not provided","href":"/v2/refunds/refunds--list","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Refunds"],"summary":"Refunds - List","description":"To list the refunds associated with a payment_id or with the merchant, if payment_id is not provided","operationId":"List all Refunds","requestBody":"7409c60d-fd55-45a1-8c5f-d7b605e1d4d9","responses":{"200":"d5354095-b55d-4495-a366-ace83fd21d0a"},"security":["4f17a94e-24fa-4315-a94f-53ea71cee8bf"],"method":"post","type":"path","servers":["f37e9e71-e224-445e-b50d-8bb9303c2220"],"path":"/v2/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":["refund_id","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>"},"refund_id":{"type":"string","description":"The identifier for the refund","isRequired":true,"uniqueKey":"refund_id","typeLabel":"string"},"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"},"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"},"connector_id_list":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"connector_id_list.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The list of merchant connector ids to filter the refunds list for selected label","uniqueKey":"connector_id_list.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":"connector_id_list.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_id_list","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","refund_id":"\u003cstring>","end_time":"2023-11-07T05:31:56Z","payment_id":"\u003cstring>","limit":123,"offset":123,"amount_filter":{"start_amount":123,"end_amount":123},"connector":["\u003cstring>"],"connector_id_list":["\u003cstring>"],"currency":[],"refund_status":[]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"d5354095-b55d-4495-a366-ace83fd21d0a":{"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":["id","payment_id","amount","currency","status","created_at","updated_at","connector","profile_id","merchant_connector_id"],"properties":{"id":{"type":"string","description":"Global Refund Id for the refund","isRequired":true,"uniqueKey":"data.items.[INDEX].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","example":6540,"minimum":100,"isRequired":true,"uniqueKey":"data.items.[INDEX].amount","typeLabel":"integer\u003cint64>"},"currency":{"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"],"isRequired":true,"uniqueKey":"data.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"The status for refunds","enum":["succeeded","failed","pending","review"],"isRequired":true,"uniqueKey":"data.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","description":"The timestamp at which refund is created","isRequired":true,"uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp at which refund is updated","isRequired":true,"uniqueKey":"data.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"connector":{"type":"string","enum":["authipay","adyenplatform","stripe_billing_test","phonypay","fauxpay","pretendpay","stripe_test","adyen_test","checkout_test","paypal_test","aci","adyen","affirm","airwallex","amazonpay","archipel","authorizedotnet","bambora","bamboraapac","bankofamerica","barclaycard","billwerk","bitpay","bluesnap","blackhawknetwork","calida","boku","braintree","breadpay","cardinal","cashtocode","celero","chargebee","checkbook","checkout","coinbase","coingate","custombilling","cryptopay","ctp_mastercard","ctp_visa","cybersource","datatrans","deutschebank","digitalvirgo","dlocal","dwolla","ebanx","elavon","facilitapay","finix","fiserv","fiservemea","fiuu","flexiti","forte","getnet","gigadat","globalpay","globepay","gocardless","gpayments","hipay","helcim","hyperswitch_vault","inespay","iatapay","itaubank","jpmorgan","juspaythreedsserver","klarna","loonio","mifinity","mollie","moneris","multisafepay","netcetera","nexinets","nexixpay","nmi","nomupay","noon","nordea","novalnet","nuvei","opennode","paybox","payload","payme","payone","paypal","paysafe","paystack","paytm","payu","peachpayments","payjustnow","payjustnowinstore","phonepe","placetopay","powertranz","prophetpay","rapyd","razorpay","recurly","redsys","santander","shift4","silverflow","square","stax","stripe","stripebilling","taxjar","threedsecureio","tesouro","tokenex","tokenio","trustpay","trustpayments","tsys","vgs","volt","wellsfargo","wise","worldline","worldpay","worldpayvantiv","worldpayxml","worldpaymodular","signifyd","plaid","riskified","xendit","zen","zift","zsl"],"isRequired":true,"uniqueKey":"data.items.[INDEX].connector","typeLabel":"enum\u003cstring>"},"profile_id":{"type":"string","description":"The id of business profile for this refund","isRequired":true,"uniqueKey":"data.items.[INDEX].profile_id","typeLabel":"string"},"merchant_connector_id":{"type":"string","description":"The merchant_connector_id of the processor through which this payment went through","isRequired":true,"uniqueKey":"data.items.[INDEX].merchant_connector_id","typeLabel":"string"},"merchant_reference_id":{"oneOf":[{"type":"string","description":"Unique Identifier for the Refund. This is to ensure idempotency for multiple partial refunds initiated against the same payment.","example":"ref_mbabizu24mvu3mela5njyhpit4","maxLength":30,"minLength":30,"uniqueKey":"data.items.[INDEX].merchant_reference_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique Identifier for the Refund. This is to ensure idempotency for multiple partial refunds initiated against the same payment.","example":"ref_mbabizu24mvu3mela5njyhpit4","maxLength":30,"minLength":30,"uniqueKey":"data.items.[INDEX].merchant_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].merchant_reference_id","typeLabel":"string | null"},"reason":{"oneOf":[{"type":"string","description":"An arbitrary string attached to the object","uniqueKey":"data.items.[INDEX].reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"An arbitrary string attached to the object","uniqueKey":"data.items.[INDEX].reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].reason","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","description":"Metadata is useful for storing additional, unstructured information on an object","uniqueKey":"data.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Metadata is useful for storing additional, unstructured information on an object","uniqueKey":"data.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].metadata","typeLabel":"object | null"},"error_details":{"oneOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].error_details.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].error_details.oneOf.0.message","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].error_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.items.[INDEX].error_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].error_details","typeLabel":"object | null"},"connector_refund_reference_id":{"oneOf":[{"type":"string","description":"The reference id of the connector for the refund","uniqueKey":"data.items.[INDEX].connector_refund_reference_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reference id of the connector for the refund","uniqueKey":"data.items.[INDEX].connector_refund_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].connector_refund_reference_id","typeLabel":"string | null"},"raw_connector_response":{"oneOf":[{"type":"string","description":"Contains raw connector response","uniqueKey":"data.items.[INDEX].raw_connector_response.oneOf.0","typeLabel":"string"},{"type":"null","description":"Contains raw 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":[{"id":"\u003cstring>","payment_id":"\u003cstring>","amount":6540,"currency":"AED","status":"succeeded","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","connector":"authipay","profile_id":"\u003cstring>","merchant_connector_id":"\u003cstring>","merchant_reference_id":"ref_mbabizu24mvu3mela5njyhpit4","reason":"\u003cstring>","metadata":{},"error_details":{"code":"\u003cstring>","message":"\u003cstring>"},"connector_refund_reference_id":"\u003cstring>","raw_connector_response":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4f17a94e-24fa-4315-a94f-53ea71cee8bf":{"api_key":{"type":"apiKey","in":"header","name":"Authorization","description":"Format: `api-key=\u003capi_key>`\n\nUse 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":{"f37e9e71-e224-445e-b50d-8bb9303c2220":{"url":"https://sandbox.birrpay.io","description":"Sandbox Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Format: `api-key=\u003capi_key>`\n\nUse 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":"Authorization","type":"string","description":"Format: `api-key=\u003capi_key>`\n\nUse 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":"Authorization"}],"title":"api_key"}]},"originalFileLocation":"v2/openapi_spec_v2.json"},"subdomain":"birrpay","siteName":"BirrPay","title":"Refunds - List - BirrPay","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/v1/refunds/refunds--list","matchLevel":1},"2.0.0 [BETA]":{"href":"/v2/refunds/refunds--list","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-24T02:55:16.700Z","originalFileLocation":"v2/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=\"To list the refunds associated with a payment_id or with the merchant, if payment_id is not 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=\"To list the refunds associated with a payment_id or with the merchant, if payment_id is not provided\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BirrPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birrpay.io/v2/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=To+list+the+refunds+associated+with+a+payment_id+or+with+the+merchant%2C+if+payment_id+is+not+provided\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=96059fd699a216f651affd75ea33c1740d1dfd683e7518e8f8d572c9bf9b24ab\">\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=\"To list the refunds associated with a payment_id or with the merchant, if payment_id is not 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=To+list+the+refunds+associated+with+a+payment_id+or+with+the+merchant%2C+if+payment_id+is+not+provided\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=96059fd699a216f651affd75ea33c1740d1dfd683e7518e8f8d572c9bf9b24ab\">\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/v2/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=\"/v2/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/v2/refunds/refunds--list#webpage\",\"url\":\"https://docs.birrpay.io/v2/refunds/refunds--list\",\"name\":\"Refunds - List\",\"description\":\"To list the refunds associated with a payment_id or with the merchant, if payment_id is not provided\",\"dateModified\":\"2026-01-24T02:55:16.700Z\",\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birrpay.io/v2/refunds/refunds--list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birrpay.io/v2/refunds/refunds--list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments Core APIs [BETA]\",\"item\":\"https://docs.birrpay.io/v2/payments/payments--create-intent\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Refunds\",\"item\":\"https://docs.birrpay.io/v2/refunds/refunds--create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Refunds - List\",\"item\":\"https://docs.birrpay.io/v2/refunds/refunds--list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birrpay.io/v2/refunds/refunds--list#apireference\",\"headline\":\"Refunds - List\",\"name\":\"Refunds - List\",\"description\":\"To list the refunds associated with a payment_id or with the merchant, if payment_id is not provided\",\"url\":\"https://docs.birrpay.io/v2/refunds/refunds--list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birrpay.io/v2/refunds/refunds--list#webpage\"},\"dateModified\":\"2026-01-24T02:55:16.700Z\",\"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","pages":[{"title":"1.0.0","href":"/v1/refunds/refunds--list"}]},{"version":"2.0.0 [BETA]","groups":[{"group":"Get Started [BETA]","pages":[{"title":"👋 Welcome to BirrPay API Reference","sidebarTitle":"Introduction","icon":"rectangle-code","iconType":"solid","href":"/introduction","hidden":false}]},{"group":"Essentials [BETA]","pages":[{"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 [BETA]","pages":[{"group":"Payments","pages":[{"openapi":"post /v2/payments/create-intent","title":"Payments - Create Intent","href":"/v2/payments/payments--create-intent"},{"openapi":"get /v2/payments/{id}/get-intent","title":"Payments - Get Intent","href":"/v2/payments/payments--get-intent"},{"openapi":"put /v2/payments/{id}/update-intent","title":"Payments - Update Intent","href":"/v2/payments/payments--update-intent"},{"openapi":"post /v2/payments/{payment_id}/create-external-sdk-tokens","title":"Payments - Session token","href":"/v2/payments/payments--session-token"},{"openapi":"get /v2/payments/{id}/payment-methods","title":"Payments - Payment Methods List","href":"/v2/payments/payments--payment-methods-list"},{"openapi":"post /v2/payments/{id}/confirm-intent","title":"Payments - Confirm Intent","href":"/v2/payments/payments--confirm-intent"},{"openapi":"get /v2/payments/{id}","title":"Payments - Get","href":"/v2/payments/payments--get"},{"openapi":"post /v2/payments","title":"Payments - Create and Confirm Intent","href":"/v2/payments/payments--create-and-confirm-intent"},{"openapi":"get /v2/payments/list","title":"Payments - List","href":"/v2/payments/payments--list"},{"openapi":"post /v2/payments/{id}/eligibility/check-balance-and-apply-pm-data","title":"Payments - Check Balance and Apply PM Data","href":"/v2/payments/payments--check-balance-and-apply-pm-data"}]},{"group":"Payment Methods","pages":[{"openapi":"post /v2/payment-methods","title":"Payment Method - Create","href":"/v2/payment-methods/payment-method--create"},{"openapi":"post /v2/payment-methods/create-intent","title":"Payment Method - Create Intent","href":"/v2/payment-methods/payment-method--create-intent"},{"openapi":"post /v2/payment-methods/{id}/confirm-intent","title":"Payment Method - Confirm Intent","href":"/v2/payment-methods/payment-method--confirm-intent"},{"openapi":"patch /v2/payment-methods/{id}/update-saved-payment-method","title":"Payment Method - Update","href":"/v2/payment-methods/payment-method--update"},{"openapi":"get /v2/payment-methods/{id}","title":"Payment Method - Retrieve","href":"/v2/payment-methods/payment-method--retrieve"},{"openapi":"delete /v2/payment-methods/{id}","title":"Payment Method - Delete","href":"/v2/payment-methods/payment-method--delete"},{"openapi":"get /v2/customers/{id}/saved-payment-methods","title":"Payment Method - List Customer Saved Payment Methods","href":"/v2/payment-methods/payment-method--list-customer-saved-payment-methods"},{"title":"List saved payment methods for a customer","href":"/v2/payment-methods/list-saved-payment-methods-for-a-customer"}]},{"group":"Network Tokenization","pages":[{"title":"Check network token status","href":"/v2/payment-methods/check-network-token-status"}]},{"group":"Payment Method Session","pages":[{"openapi":"post /v2/payment-method-sessions","title":"Payment Method Session - Create","href":"/v2/payment-method-session/payment-method-session--create"},{"openapi":"get /v2/payment-method-sessions/{id}","title":"Payment Method Session - Retrieve","href":"/v2/payment-method-session/payment-method-session--retrieve"},{"openapi":"get /v2/payment-method-sessions/{id}/list-payment-methods","title":"Payment Method Session - List Payment Methods","href":"/v2/payment-method-session/payment-method-session--list-payment-methods"},{"openapi":"put /v2/payment-method-sessions/{id}/update-saved-payment-method","title":"Payment Method Session - Update a saved payment method","href":"/v2/payment-method-session/payment-method-session--update-a-saved-payment-method"},{"openapi":"post /v2/payment-method-sessions/{id}/confirm","title":"Payment Method Session - Confirm a payment method session","href":"/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session"},{"openapi":"delete /v2/payment-method-sessions/{id}","title":"Payment Method Session - Delete a saved payment method","href":"/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method"}]},{"group":"Customers","pages":[{"openapi":"post /v2/customers","title":"Customers - Create","href":"/v2/customers/customers--create"},{"openapi":"get /v2/customers/{id}","title":"Customers - Retrieve","href":"/v2/customers/customers--retrieve"},{"openapi":"post /v2/customers/{id}","title":"Customers - Update","href":"/v2/customers/customers--update"},{"openapi":"delete /v2/customers/{id}","title":"Customers - Delete","href":"/v2/customers/customers--delete"},{"openapi":"get /v2/customers/list","title":"Customers - List","href":"/v2/customers/customers--list"}]},{"group":"Refunds","pages":[{"openapi":"post /v2/refunds","title":"Refunds - Create","href":"/v2/refunds/refunds--create"},{"openapi":"put /v2/refunds/{id}/update_metadata","title":null,"href":"/v2/refunds/refunds--metadata-update"},{"openapi":"get /v2/refunds/{id}","title":"Refunds - Retrieve","description":"Retrieves a Refund. This may be used to get the status of a previously initiated refund","href":"/v2/refunds/refunds--retrieve"},{"openapi":"post /v2/refunds/list","title":"Refunds - List","href":"/v2/refunds/refunds--list"}]}]},{"group":"Account management APIs [BETA]","pages":[{"group":"Organization","pages":[{"openapi":"post /v2/organizations","title":"Organization - Create","description":"Create a new organization","href":"/v2/organization/organization--create"},{"openapi":"get /v2/organizations/{id}","title":"Organization - Retrieve","href":"/v2/organization/organization--retrieve"},{"openapi":"put /v2/organizations/{id}","title":"Organization - Update","href":"/v2/organization/organization--update"},{"openapi":"get /v2/organizations/{id}/merchant-accounts","title":"Organization - Merchant Account - List","href":"/v2/organization/organization--merchant-account--list"}]},{"group":"Merchant Account","pages":[{"openapi":"post /v2/merchant-accounts","title":"Merchant Account - Create","href":"/v2/merchant-account/merchant-account--create"},{"openapi":"get /v2/merchant-accounts/{id}","title":"Merchant Account - Retrieve","href":"/v2/merchant-account/merchant-account--retrieve"},{"openapi":"put /v2/merchant-accounts/{id}","title":"Merchant Account - Update","href":"/v2/merchant-account/merchant-account--update"},{"openapi":"get /v2/merchant-accounts/{id}/profiles","title":"Merchant Account - Profile List","href":"/v2/merchant-account/business-profile--list"}]},{"group":"Profile","pages":[{"openapi":"post /v2/profiles","title":"Profile - Create","href":"/v2/profile/profile--create"},{"openapi":"put /v2/profiles/{id}","title":"Profile - Update","href":"/v2/profile/profile--update"},{"openapi":"patch /v2/profiles/{id}/activate-routing-algorithm","title":"Profile - Activate routing algorithm","href":"/v2/profile/profile--activate-routing-algorithm"},{"openapi":"patch /v2/profiles/{id}/fallback-routing","title":"Profile - Update Default Fallback Routing Algorithm","href":"/v2/profile/profile--update-default-fallback-routing-algorithm"},{"openapi":"patch /v2/profiles/{id}/deactivate-routing-algorithm","title":"Profile - Deactivate routing algorithm","href":"/v2/profile/profile--deactivate-routing-algorithm"},{"openapi":"get /v2/profiles/{id}","title":"Profile - Retrieve","href":"/v2/profile/profile--retrieve"},{"openapi":"get /v2/profiles/{id}/connector-accounts","title":"Profile - Connector Accounts List","href":"/v2/profile/merchant-connector--list"},{"openapi":"get /v2/profiles/{id}/routing-algorithm","title":"Profile - Retrieve Active Routing Algorithm","href":"/v2/profile/profile--retrieve-active-routing-algorithm"},{"openapi":"get /v2/profiles/{id}/fallback-routing","title":"Profile - Retrieve Default Fallback Routing Algorithm","href":"/v2/profile/profile--retrieve-default-fallback-routing-algorithm"}]},{"group":"Connector Account","pages":[{"openapi":"post /v2/connector-accounts","title":"Connector Account - Create","href":"/v2/connector-account/connector-account--create"},{"openapi":"get /v2/connector-accounts/{id}","title":"Connector Account - Retrieve","href":"/v2/connector-account/connector-account--retrieve"},{"openapi":"put /v2/connector-accounts/{id}","title":"Connector Account - Update","href":"/v2/connector-account/connector-account--update"}]},{"group":"API Key","pages":[{"openapi":"post /v2/api-keys","title":"API Key - Create","href":"/v2/api-key/api-key--create"},{"openapi":"get /v2/api-keys/{id}","title":"API Key - Retrieve","href":"/v2/api-key/api-key--retrieve"},{"openapi":"put /v2/api-keys/{id}","title":"API Key - Update","href":"/v2/api-key/api-key--update"},{"openapi":"delete /v2/api-keys/{id}","title":"API Key - Revoke","href":"/v2/api-key/api-key--revoke"},{"openapi":"get /v2/api-keys/list","title":"API Key - List","href":"/v2/api-key/api-key--list"}]},{"group":"Routing","pages":[{"openapi":"post /v2/routing-algorithms","title":"Routing - Create","href":"/v2/routing/routing--create"},{"openapi":"get /v2/routing-algorithms/{id}","title":"Routing - Retrieve","href":"/v2/routing/routing--retrieve"}]}]},{"group":"Other APIs [BETA]","pages":[{"group":"Proxy","pages":[{"openapi":"post /proxy","title":"Proxy","href":"/v2/proxy/proxy"}]},{"group":"Tokenization","pages":[{"openapi":"post /v2/tokenize","title":"Tokenization - Create","href":"/v2/tokenization/tokenization--create"}]},{"group":"Revenue Recovery","pages":[{"openapi":"get /v2/process-trackers/revenue-recovery-workflow/{revenue_recovery_id}","title":"Revenue Recovery - Retrieve","href":"/v2/revenue-recovery/revenue-recovery--retrieve"}]}]}]}]},{"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"]}