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.
{"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/payment-methods/payment-method--list-customer-saved-payment-methods","slug":"/v2/payment-methods/payment-method--list-customer-saved-payment-methods","pageMetadata":{"openapi":"get /v2/customers/{id}/saved-payment-methods","title":"Payment Method - List Customer Saved Payment Methods","description":"List the payment methods saved for a customer","href":"/v2/payment-methods/payment-method--list-customer-saved-payment-methods","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: \"List the payment methods saved for a customer\"\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":"get /v2/customers/{id}/saved-payment-methods","title":"Payment Method - List Customer Saved Payment Methods","description":"List the payment methods saved for a customer","href":"/v2/payment-methods/payment-method--list-customer-saved-payment-methods","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payment Methods"],"summary":"Payment Method - List Customer Saved Payment Methods","description":"List the payment methods saved for a customer","operationId":"List Customer Saved Payment Methods","parameters":["244478e4-ad84-40c5-8310-b272514e30ec"],"responses":{"200":"2aff6706-632e-417e-9857-1f8fb87d2a56","404":"beb3a2ca-7383-4d49-84ac-fa5d4516b1ce"},"security":["02150fc7-dbd1-41c9-a892-7ebe8749751c"],"method":"get","type":"path","servers":["f37e9e71-e224-445e-b50d-8bb9303c2220"],"path":"/v2/customers/{id}/saved-payment-methods","baseUrlOptions":["https://sandbox.birrpay.io"],"title":"Payment Method - List Customer Saved Payment Methods","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"244478e4-ad84-40c5-8310-b272514e30ec":{"name":"id","in":"path","description":"The unique identifier for the customer","required":true,"schema":{"type":"string","isRequired":true,"description":"The unique identifier for the customer","uniqueKey":"","typeLabel":"string"}}},"responses":{"2aff6706-632e-417e-9857-1f8fb87d2a56":{"description":"Payment Methods Retrieved","content":{"application/json":{"schema":{"type":"object","required":["customer_payment_methods"],"properties":{"customer_payment_methods":{"type":"array","items":{"type":"object","required":["id","customer_id","payment_method_type","payment_method_subtype","created","requires_cvv","is_default","psp_tokenization_enabled"],"properties":{"id":{"type":"string","description":"The unique identifier of the payment method.","example":"12345_pm_01926c58bc6e77c09e809964e72af8c8","isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].id","typeLabel":"string"},"customer_id":{"type":"string","description":"The unique identifier of the customer.","example":"12345_cus_01926c58bc6e77c09e809964e72af8c8","maxLength":64,"minLength":32,"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].customer_id","typeLabel":"string"},"payment_method_type":{"type":"string","description":"Indicates the type of payment method. Eg: 'card', 'wallet', etc.","enum":["card","card_redirect","pay_later","wallet","bank_redirect","bank_transfer","crypto","bank_debit","reward","real_time_payment","upi","voucher","gift_card","open_banking","mobile_payment","network_token"],"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_type","typeLabel":"enum\u003cstring>"},"payment_method_subtype":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eps","flexiti","fps","evoucher","giropay","givex","google_pay","go_pay","gcash","ideal","interac","indomaret","klarna","kakao_pay","local_bank_redirect","mandiri_va","knet","mb_way","mobile_pay","momo","momo_atm","multibanco","online_banking_thailand","online_banking_czech_republic","online_banking_finland","online_banking_fpx","online_banking_poland","online_banking_slovakia","oxxo","pago_efectivo","permata_bank_transfer","open_banking_uk","pay_bright","payjustnow","paypal","paze","pix","pay_safe_card","przelewy24","prompt_pay","pse","qris","red_compra","red_pagos","samsung_pay","sepa","sepa_bank_transfer","sepa_guarenteed_debit","skrill","sofort","swish","touch_n_go","trustly","twint","upi_collect","upi_intent","upi_qr","vipps","viet_qr","venmo","walley","we_chat_pay","seven_eleven","lawson","mini_stop","family_mart","seicomart","pay_easy","local_bank_transfer","mifinity","open_banking_pis","direct_carrier_billing","instant_bank_transfer","instant_bank_transfer_finland","instant_bank_transfer_poland","revolut_pay","indonesian_bank_transfer","open_banking","network_token"],"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_subtype","typeLabel":"enum\u003cstring>"},"created":{"type":"string","format":"date-time","description":"A timestamp (ISO 8601 code) that determines when the payment method was created","example":"2023-01-18T11:04:09.922Z","isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].created","typeLabel":"string\u003cdate-time>"},"requires_cvv":{"type":"boolean","description":"Whether this payment method requires CVV to be collected","example":true,"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].requires_cvv","typeLabel":"boolean"},"is_default":{"type":"boolean","description":"Indicates if the payment method has been set to default or not","example":true,"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].is_default","typeLabel":"boolean"},"psp_tokenization_enabled":{"type":"boolean","description":"Whether psp_tokenization is enabled for the payment_method, this will be true when at least\none multi-use token with status `Active` is available for the payment method","isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].psp_tokenization_enabled","typeLabel":"boolean"},"recurring_enabled":{"oneOf":[{"type":"boolean","description":"Indicates whether the payment method supports recurring payments. Optional.","example":true,"uniqueKey":"customer_payment_methods.items.[INDEX].recurring_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether the payment method supports recurring payments. Optional.","example":true,"uniqueKey":"customer_payment_methods.items.[INDEX].recurring_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].recurring_enabled","typeLabel":"boolean | null"},"payment_method_data":{"oneOf":[{"type":"object","required":["card"],"properties":{"card":{"type":"object","required":["saved_to_locker"],"properties":{"saved_to_locker":{"type":"boolean","example":true,"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.saved_to_locker","typeLabel":"boolean"},"issuer_country":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.issuer_country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.issuer_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.issuer_country","typeLabel":"enum\u003cstring> | null"},"last4_digits":{"oneOf":[{"type":"string","example":"4242","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.last4_digits.oneOf.0","typeLabel":"string"},{"type":"null","example":"4242","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.last4_digits.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.last4_digits","typeLabel":"string | null"},"expiry_month":{"oneOf":[{"type":"string","example":"10","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.expiry_month.oneOf.0","typeLabel":"string"},{"type":"null","example":"10","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.expiry_month.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.expiry_month","typeLabel":"string | null"},"expiry_year":{"oneOf":[{"type":"string","example":"25","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.expiry_year.oneOf.0","typeLabel":"string"},{"type":"null","example":"25","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.expiry_year.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.expiry_year","typeLabel":"string | null"},"card_holder_name":{"oneOf":[{"type":"string","example":"John Doe","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_holder_name.oneOf.0","typeLabel":"string"},{"type":"null","example":"John Doe","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_holder_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_holder_name","typeLabel":"string | null"},"card_fingerprint":{"oneOf":[{"type":"string","example":"fingerprint_12345","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_fingerprint.oneOf.0","typeLabel":"string"},{"type":"null","example":"fingerprint_12345","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_fingerprint.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_fingerprint","typeLabel":"string | null"},"nick_name":{"oneOf":[{"type":"string","example":"Card","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.nick_name.oneOf.0","typeLabel":"string"},{"type":"null","example":"Card","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.nick_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.nick_name","typeLabel":"string | null"},"card_network":{"oneOf":[{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce"],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_network.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_network.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_network","typeLabel":"enum\u003cstring> | null"},"card_isin":{"oneOf":[{"type":"string","example":"4567890","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_isin.oneOf.0","typeLabel":"string"},{"type":"null","example":"4567890","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_isin.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_isin","typeLabel":"string | null"},"card_issuer":{"oneOf":[{"type":"string","example":"Issuer Bank","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_issuer.oneOf.0","typeLabel":"string"},{"type":"null","example":"Issuer Bank","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_issuer.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_issuer","typeLabel":"string | null"},"card_type":{"oneOf":[{"type":"string","example":"Credit","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_type.oneOf.0","typeLabel":"string"},{"type":"null","example":"Credit","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card.card_type","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0.card","typeLabel":"object"}},"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.0","typeLabel":"object"},{"type":"object","required":["bank"],"properties":{"bank":{"oneOf":[{"type":"object","required":["bank_account_number","bank_routing_number"],"properties":{"bank_account_number":{"type":"string","description":"Bank account number is an unique identifier assigned by a bank to a customer.","example":"000123456","isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.0.bank_account_number","typeLabel":"string"},"bank_routing_number":{"type":"string","description":"[9 digits] Routing number - used in USA for identifying a specific bank.","example":"110000000","isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.0.bank_routing_number","typeLabel":"string"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name","example":"Deutsche Bank","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.0.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name","example":"Deutsche Bank","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.0.bank_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.0.bank_name","typeLabel":"string | null"},"bank_country_code":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.0.bank_country_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.0.bank_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.0.bank_country_code","typeLabel":"enum\u003cstring> | null"},"bank_city":{"oneOf":[{"type":"string","description":"Bank city","example":"California","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.0.bank_city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank city","example":"California","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.0.bank_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.0.bank_city","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.0","typeLabel":"object"},{"type":"object","required":["bank_account_number","bank_sort_code"],"properties":{"bank_account_number":{"type":"string","description":"Bank account number is an unique identifier assigned by a bank to a customer.","example":"000123456","isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.1.bank_account_number","typeLabel":"string"},"bank_sort_code":{"type":"string","description":"[6 digits] Sort Code - used in UK and Ireland for identifying a bank and it's branches.","example":"98-76-54","isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.1.bank_sort_code","typeLabel":"string"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name","example":"Deutsche Bank","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.1.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name","example":"Deutsche Bank","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.1.bank_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.1.bank_name","typeLabel":"string | null"},"bank_country_code":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.1.bank_country_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.1.bank_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.1.bank_country_code","typeLabel":"enum\u003cstring> | null"},"bank_city":{"oneOf":[{"type":"string","description":"Bank city","example":"California","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.1.bank_city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank city","example":"California","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.1.bank_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.1.bank_city","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.1","typeLabel":"object"},{"type":"object","required":["iban","bic"],"properties":{"iban":{"type":"string","description":"International Bank Account Number (iban) - used in many countries for identifying a bank along with it's customer.","example":"DE89370400440532013000","isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.2.iban","typeLabel":"string"},"bic":{"type":"string","description":"[8 / 11 digits] Bank Identifier Code (bic) / Swift Code - used in many countries for identifying a bank and it's branches","example":"HSBCGB2LXXX","isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.2.bic","typeLabel":"string"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name","example":"Deutsche Bank","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.2.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name","example":"Deutsche Bank","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.2.bank_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.2.bank_name","typeLabel":"string | null"},"bank_country_code":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.2.bank_country_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.2.bank_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.2.bank_country_code","typeLabel":"enum\u003cstring> | null"},"bank_city":{"oneOf":[{"type":"string","description":"Bank city","example":"California","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.2.bank_city.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank city","example":"California","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.2.bank_city.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.2.bank_city","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.2","typeLabel":"object"},{"type":"object","required":["bank_account_number","pix_key"],"properties":{"bank_account_number":{"type":"string","description":"Bank account number is an unique identifier assigned by a bank to a customer.","example":"000123456","isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.3.bank_account_number","typeLabel":"string"},"pix_key":{"type":"string","description":"Unique key for pix customer","example":"000123456","isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.3.pix_key","typeLabel":"string"},"bank_name":{"oneOf":[{"type":"string","description":"Bank name","example":"Deutsche Bank","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.3.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank name","example":"Deutsche Bank","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.3.bank_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.3.bank_name","typeLabel":"string | null"},"bank_branch":{"oneOf":[{"type":"string","description":"Bank branch","example":"3707","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.3.bank_branch.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank branch","example":"3707","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.3.bank_branch.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.3.bank_branch","typeLabel":"string | null"},"tax_id":{"oneOf":[{"type":"string","description":"Individual taxpayer identification number","example":"000123456","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.3.tax_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Individual taxpayer identification number","example":"000123456","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.3.tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.3.tax_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank.oneOf.3","typeLabel":"object"}],"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1.bank","typeLabel":"object"}},"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data.oneOf.2","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].payment_method_data","typeLabel":"object · object · null"},"bank":{"oneOf":[{"type":"object","required":["mask"],"properties":{"mask":{"type":"string","isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].bank.oneOf.0.mask","typeLabel":"string"}},"uniqueKey":"customer_payment_methods.items.[INDEX].bank.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].bank.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].bank","typeLabel":"object | null"},"last_used_at":{"type":"string","format":"date-time","description":"A timestamp (ISO 8601 code) that determines when the payment method was last used","example":"2024-02-24T11:04:09.922Z","uniqueKey":"customer_payment_methods.items.[INDEX].last_used_at","typeLabel":"string\u003cdate-time>"},"billing":{"oneOf":[{"type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"Address details","properties":{"city":{"oneOf":[{"type":"string","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.country","typeLabel":"enum\u003cstring> | null"},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"line3":{"oneOf":[{"type":"string","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.line3","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The address state","example":"New York","uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address state","example":"New York","uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.last_name","typeLabel":"string | null"},"origin_zip":{"oneOf":[{"type":"string","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.origin_zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.origin_zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0.origin_zip","typeLabel":"string | null"}},"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.address","typeLabel":"object | null"},"phone":{"oneOf":[{"type":"object","properties":{"number":{"oneOf":[{"type":"string","description":"The contact number","example":"9123456789","uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.phone.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The contact number","example":"9123456789","uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.phone.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.phone.oneOf.0.number","typeLabel":"string | null"},"country_code":{"oneOf":[{"type":"string","description":"The country code attached to the number","example":"+1","uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.phone.oneOf.0.country_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The country code attached to the number","example":"+1","uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.phone.oneOf.0.country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.phone.oneOf.0.country_code","typeLabel":"string | null"}},"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.phone.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.phone","typeLabel":"object | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].billing.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].billing","typeLabel":"object | null"},"network_tokenization":{"oneOf":[{"type":"object","required":["payment_method_data"],"properties":{"payment_method_data":{"type":"object","properties":{"last4_digits":{"oneOf":[{"type":"string","example":"4242","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.last4_digits.oneOf.0","typeLabel":"string"},{"type":"null","example":"4242","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.last4_digits.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.last4_digits","typeLabel":"string | null"},"issuer_country":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.issuer_country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.issuer_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.issuer_country","typeLabel":"enum\u003cstring> | null"},"network_token_expiry_month":{"oneOf":[{"type":"string","example":"05","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.network_token_expiry_month.oneOf.0","typeLabel":"string"},{"type":"null","example":"05","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.network_token_expiry_month.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.network_token_expiry_month","typeLabel":"string | null"},"network_token_expiry_year":{"oneOf":[{"type":"string","example":"27","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.network_token_expiry_year.oneOf.0","typeLabel":"string"},{"type":"null","example":"27","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.network_token_expiry_year.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.network_token_expiry_year","typeLabel":"string | null"},"nick_name":{"oneOf":[{"type":"string","example":"Card","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.nick_name.oneOf.0","typeLabel":"string"},{"type":"null","example":"Card","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.nick_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.nick_name","typeLabel":"string | null"},"card_holder_name":{"oneOf":[{"type":"string","example":"John Doe","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_holder_name.oneOf.0","typeLabel":"string"},{"type":"null","example":"John Doe","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_holder_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_holder_name","typeLabel":"string | null"},"card_isin":{"oneOf":[{"type":"string","example":"16712672","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_isin.oneOf.0","typeLabel":"string"},{"type":"null","example":"16712672","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_isin.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_isin","typeLabel":"string | null"},"card_issuer":{"oneOf":[{"type":"string","example":"Bank of America","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_issuer.oneOf.0","typeLabel":"string"},{"type":"null","example":"Bank of America","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_issuer.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_issuer","typeLabel":"string | null"},"card_network":{"oneOf":[{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce"],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_network.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_network.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_network","typeLabel":"enum\u003cstring> | null"},"card_type":{"oneOf":[{"type":"string","example":"Credit","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_type.oneOf.0","typeLabel":"string"},{"type":"null","example":"Credit","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.card_type","typeLabel":"string | null"},"saved_to_locker":{"type":"boolean","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data.saved_to_locker","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0.payment_method_data","typeLabel":"object"}},"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_payment_methods.items.[INDEX].network_tokenization","typeLabel":"object | null"}},"uniqueKey":"customer_payment_methods.items.[INDEX]","typeLabel":"object"},"description":"List of payment methods for customer","isRequired":true,"uniqueKey":"customer_payment_methods","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customer_payment_methods":[{"id":"12345_pm_01926c58bc6e77c09e809964e72af8c8","customer_id":"12345_cus_01926c58bc6e77c09e809964e72af8c8","payment_method_type":"card","payment_method_subtype":"ach","created":"2023-01-18T11:04:09.922Z","requires_cvv":true,"is_default":true,"psp_tokenization_enabled":true,"recurring_enabled":true,"payment_method_data":{"card":{"saved_to_locker":true,"issuer_country":"AF","last4_digits":"4242","expiry_month":"10","expiry_year":"25","card_holder_name":"John Doe","card_fingerprint":"fingerprint_12345","nick_name":"Card","card_network":"Visa","card_isin":"4567890","card_issuer":"Issuer Bank","card_type":"Credit"}},"bank":{"mask":"\u003cstring>"},"last_used_at":"2024-02-24T11:04:09.922Z","billing":{"address":{"city":"New York","country":"AF","line1":"123, King Street","line2":"Powelson Avenue","line3":"Bridgewater","zip":"08807","state":"New York","first_name":"John","last_name":"Doe","origin_zip":"08807"},"phone":{"number":"9123456789","country_code":"+1"},"email":"\u003cstring>"},"network_tokenization":{"payment_method_data":{"last4_digits":"4242","issuer_country":"AF","network_token_expiry_month":"05","network_token_expiry_year":"27","nick_name":"Card","card_holder_name":"John Doe","card_isin":"16712672","card_issuer":"Bank of America","card_network":"Visa","card_type":"Credit","saved_to_locker":true}}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"beb3a2ca-7383-4d49-84ac-fa5d4516b1ce":{"description":"Customer Not Found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"02150fc7-dbd1-41c9-a892-7ebe8749751c":{"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":"Payment Method - List Customer Saved Payment Methods - BirrPay","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/introduction","matchLevel":3},"2.0.0 [BETA]":{"href":"/v2/payment-methods/payment-method--list-customer-saved-payment-methods","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-24T02:55:16.618Z","originalFileLocation":"v2/payment-methods/payment-method--list-customer-saved-payment-methods.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=\"List the payment methods saved for a customer\">\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=\"Payment Method - List Customer Saved Payment Methods - BirrPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"List the payment methods saved for a customer\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BirrPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birrpay.io/v2/payment-methods/payment-method--list-customer-saved-payment-methods\">\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=Payment+Methods\u0026amp;title=Payment+Method+-+List+Customer+Saved+Payment+Methods\u0026amp;description=List+the+payment+methods+saved+for+a+customer\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=0ad5975d2a2419898cbbb27a530fcc1e701ab43b296750fbe10df79615df9909\">\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=\"Payment Method - List Customer Saved Payment Methods - BirrPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List the payment methods saved for a customer\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Payment+Methods\u0026amp;title=Payment+Method+-+List+Customer+Saved+Payment+Methods\u0026amp;description=List+the+payment+methods+saved+for+a+customer\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=0ad5975d2a2419898cbbb27a530fcc1e701ab43b296750fbe10df79615df9909\">\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/payment-methods/payment-method--list-customer-saved-payment-methods\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/payment-methods/payment-method--list-customer-saved-payment-methods.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/payment-methods/payment-method--list-customer-saved-payment-methods#webpage\",\"url\":\"https://docs.birrpay.io/v2/payment-methods/payment-method--list-customer-saved-payment-methods\",\"name\":\"Payment Method - List Customer Saved Payment Methods\",\"description\":\"List the payment methods saved for a customer\",\"dateModified\":\"2026-01-24T02:55:16.618Z\",\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birrpay.io/v2/payment-methods/payment-method--list-customer-saved-payment-methods#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birrpay.io/v2/payment-methods/payment-method--list-customer-saved-payment-methods#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\":\"Payment Methods\",\"item\":\"https://docs.birrpay.io/v2/payment-methods/payment-method--create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Payment Method - List Customer Saved Payment Methods\",\"item\":\"https://docs.birrpay.io/v2/payment-methods/payment-method--list-customer-saved-payment-methods\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birrpay.io/v2/payment-methods/payment-method--list-customer-saved-payment-methods#apireference\",\"headline\":\"Payment Method - List Customer Saved Payment Methods\",\"name\":\"Payment Method - List Customer Saved Payment Methods\",\"description\":\"List the payment methods saved for a customer\",\"url\":\"https://docs.birrpay.io/v2/payment-methods/payment-method--list-customer-saved-payment-methods\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birrpay.io/v2/payment-methods/payment-method--list-customer-saved-payment-methods#webpage\"},\"dateModified\":\"2026-01-24T02:55:16.618Z\",\"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":"/introduction"}]},{"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","description":"Deletes a payment method of a customer.","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","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","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":"Payment Method - List Customer Saved Payment Methods - 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"]}