Create a payment method session for a customer
This is used to list the saved payment methods for the customer
The customer can also add a new payment method using this session
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-method-session/payment-method-session--create","slug":"/v2/payment-method-session/payment-method-session--create","pageMetadata":{"openapi":"post /v2/payment-method-sessions","title":"Payment Method Session - Create","description":"Create a payment method session for a customer\nThis is used to list the saved payment methods for the customer\nThe customer can also add a new payment method using this session","href":"/v2/payment-method-session/payment-method-session--create","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: \"Create a payment method session for a customer\\nThis is used to list the saved payment methods for the customer\\nThe customer can also add a new payment method using this session\"\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/payment-method-sessions","title":"Payment Method Session - Create","description":"Create a payment method session for a customer\nThis is used to list the saved payment methods for the customer\nThe customer can also add a new payment method using this session","href":"/v2/payment-method-session/payment-method-session--create","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payment Method Session"],"summary":"Payment Method Session - Create","description":"Create a payment method session for a customer\nThis is used to list the saved payment methods for the customer\nThe customer can also add a new payment method using this session","operationId":"Create a payment method session","requestBody":"00705654-2867-4274-9ef8-e0b969c8d4d4","responses":{"200":"14fc4651-2393-4793-8128-c38b85d2bf9f","400":"f432d6e5-b493-42a2-bf5e-f2c9e69d26b0"},"security":["3639ffe4-ff32-426a-9bbc-53748b60deb5"],"method":"post","type":"path","servers":["f37e9e71-e224-445e-b50d-8bb9303c2220"],"path":"/v2/payment-method-sessions","baseUrlOptions":["https://sandbox.birrpay.io"],"title":"Payment Method Session - Create","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"oneOf":[{"type":"string","description":"The customer id for which the payment methods session is to be created","example":"cus_y3oqhf46pyzuxjbcn2giaqnb44","uniqueKey":"customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer id for which the payment methods session is to be created","example":"cus_y3oqhf46pyzuxjbcn2giaqnb44","uniqueKey":"customer_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_id","typeLabel":"string | null"},"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":"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":"billing.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"billing.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"billing.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The address state","example":"New York","uniqueKey":"billing.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address state","example":"New York","uniqueKey":"billing.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.origin_zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.origin_zip","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address","typeLabel":"object | null"},"phone":{"oneOf":[{"type":"object","properties":{"number":{"oneOf":[{"type":"string","description":"The contact number","example":"9123456789","uniqueKey":"billing.oneOf.0.phone.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The contact number","example":"9123456789","uniqueKey":"billing.oneOf.0.phone.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.phone.oneOf.0.country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone.oneOf.0.country_code","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0.phone.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone","typeLabel":"object | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"billing.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"billing.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing","typeLabel":"object | null"},"return_url":{"oneOf":[{"type":"string","description":"The return url to which the customer should be redirected to after adding the payment method","uniqueKey":"return_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The return url to which the customer should be redirected to after adding the payment method","uniqueKey":"return_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"return_url","typeLabel":"string | null"},"psp_tokenization":{"oneOf":[{"type":"object","description":"The Payment Service Provider Configuration for payment methods that are created using the payment method session","required":["tokenization_type","connector_id"],"properties":{"tokenization_type":{"type":"string","description":"The type of tokenization to use for the payment method","enum":["single_use","multi_use"],"isRequired":true,"uniqueKey":"psp_tokenization.oneOf.0.tokenization_type","typeLabel":"enum\u003cstring>"},"connector_id":{"type":"string","description":"The merchant connector id to be used for tokenization","example":"mca_28a7367sad8239s67","isRequired":true,"uniqueKey":"psp_tokenization.oneOf.0.connector_id","typeLabel":"string"}},"uniqueKey":"psp_tokenization.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"psp_tokenization.oneOf.1","typeLabel":"null"}],"uniqueKey":"psp_tokenization","typeLabel":"object | null"},"network_tokenization":{"oneOf":[{"type":"object","description":"The network tokenization configuration for creating the payment method session","required":["enable"],"properties":{"enable":{"type":"string","description":"The network tokenization toggle, whether to enable or skip the network tokenization","enum":["Enable","Skip"],"isRequired":true,"uniqueKey":"network_tokenization.oneOf.0.enable","typeLabel":"enum\u003cstring>"}},"uniqueKey":"network_tokenization.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"network_tokenization.oneOf.1","typeLabel":"null"}],"uniqueKey":"network_tokenization","typeLabel":"object | null"},"expires_in":{"oneOf":[{"type":"integer","format":"int32","description":"The time (seconds ) when the session will expire\nIf not provided, the session will expire in 15 minutes","default":900,"example":900,"minimum":0,"uniqueKey":"expires_in.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"The time (seconds ) when the session will expire\nIf not provided, the session will expire in 15 minutes","default":900,"example":900,"minimum":0,"uniqueKey":"expires_in.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_in","typeLabel":"integer\u003cint32> | null"},"tokenization_data":{"oneOf":[{"description":"Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data","uniqueKey":"tokenization_data.oneOf.0","typeLabel":"any"},{"description":"Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data","type":"null","uniqueKey":"tokenization_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"tokenization_data","typeLabel":"any | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Create a payment method session with customer_id":{"title":"Create a payment method session with customer_id","value":{"customer_id":"12345_cus_abcdefghijklmnopqrstuvwxyz"}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"14fc4651-2393-4793-8128-c38b85d2bf9f":{"description":"Create the payment method session","content":{"application/json":{"schema":{"type":"object","required":["id","expires_at","client_secret"],"properties":{"id":{"type":"string","example":"12345_pms_01926c58bc6e77c09e809964e72af8c8","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"expires_at":{"type":"string","format":"date-time","description":"The iso timestamp when the session will expire\nTrying to retrieve the session or any operations on the session after this time will result in an error","example":"2023-01-18T11:04:09.922Z","isRequired":true,"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time>"},"client_secret":{"type":"string","description":"Client Secret","example":"cs_9wcXDRVkfEtLEsSnYKgQ","isRequired":true,"uniqueKey":"client_secret","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","description":"The customer id for which the payment methods session is to be created","example":"12345_cus_01926c58bc6e77c09e809964e72af8c8","uniqueKey":"customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer id for which the payment methods session is to be created","example":"12345_cus_01926c58bc6e77c09e809964e72af8c8","uniqueKey":"customer_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_id","typeLabel":"string | null"},"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":"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":"billing.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"billing.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"billing.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The address state","example":"New York","uniqueKey":"billing.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address state","example":"New York","uniqueKey":"billing.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.address.oneOf.0.origin_zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.origin_zip","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address","typeLabel":"object | null"},"phone":{"oneOf":[{"type":"object","properties":{"number":{"oneOf":[{"type":"string","description":"The contact number","example":"9123456789","uniqueKey":"billing.oneOf.0.phone.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The contact number","example":"9123456789","uniqueKey":"billing.oneOf.0.phone.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"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":"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":"billing.oneOf.0.phone.oneOf.0.country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone.oneOf.0.country_code","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0.phone.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone","typeLabel":"object | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"billing.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"billing.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing","typeLabel":"object | null"},"psp_tokenization":{"oneOf":[{"type":"object","description":"The Payment Service Provider Configuration for payment methods that are created using the payment method session","required":["tokenization_type","connector_id"],"properties":{"tokenization_type":{"type":"string","description":"The type of tokenization to use for the payment method","enum":["single_use","multi_use"],"isRequired":true,"uniqueKey":"psp_tokenization.oneOf.0.tokenization_type","typeLabel":"enum\u003cstring>"},"connector_id":{"type":"string","description":"The merchant connector id to be used for tokenization","example":"mca_28a7367sad8239s67","isRequired":true,"uniqueKey":"psp_tokenization.oneOf.0.connector_id","typeLabel":"string"}},"uniqueKey":"psp_tokenization.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"psp_tokenization.oneOf.1","typeLabel":"null"}],"uniqueKey":"psp_tokenization","typeLabel":"object | null"},"network_tokenization":{"oneOf":[{"type":"object","description":"The network tokenization configuration for creating the payment method session","required":["enable"],"properties":{"enable":{"type":"string","description":"The network tokenization toggle, whether to enable or skip the network tokenization","enum":["Enable","Skip"],"isRequired":true,"uniqueKey":"network_tokenization.oneOf.0.enable","typeLabel":"enum\u003cstring>"}},"uniqueKey":"network_tokenization.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"network_tokenization.oneOf.1","typeLabel":"null"}],"uniqueKey":"network_tokenization","typeLabel":"object | null"},"tokenization_data":{"oneOf":[{"description":"Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data","uniqueKey":"tokenization_data.oneOf.0","typeLabel":"any"},{"description":"Contains data to be passed on to tokenization service ( if present ) to create token_id for given JSON data","type":"null","uniqueKey":"tokenization_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"tokenization_data","typeLabel":"any | null"},"return_url":{"oneOf":[{"type":"string","description":"The return url to which the user should be redirected to","example":"https://merchant-website.com/return","uniqueKey":"return_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The return url to which the user should be redirected to","example":"https://merchant-website.com/return","uniqueKey":"return_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"return_url","typeLabel":"string | null"},"next_action":{"oneOf":[{"type":"object","description":"Contains the url for redirection flow","required":["redirect_to_url","type"],"properties":{"redirect_to_url":{"type":"string","example":"https://example.com/redirect","isRequired":true,"uniqueKey":"next_action.oneOf.0.redirect_to_url","typeLabel":"string"},"type":{"type":"string","enum":["redirect_to_url"],"isRequired":true,"uniqueKey":"next_action.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.0","typeLabel":"object"},{"type":"object","description":"Informs the next steps for bank transfer and also contains the charges details (ex: amount received, amount charged etc)","required":["bank_transfer_steps_and_charges_details","type"],"properties":{"bank_transfer_steps_and_charges_details":{"oneOf":[{"type":"object","required":["doku_bank_transfer_instructions"],"properties":{"doku_bank_transfer_instructions":{"type":"object","required":["expires_at","reference","instructions_url"],"properties":{"expires_at":{"type":"string","example":"1707091200000","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.doku_bank_transfer_instructions.expires_at","typeLabel":"string"},"reference":{"type":"string","example":"122385736258","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.doku_bank_transfer_instructions.reference","typeLabel":"string"},"instructions_url":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.doku_bank_transfer_instructions.instructions_url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.doku_bank_transfer_instructions","typeLabel":"object"},"receiver":{"oneOf":[{"type":"object","required":["amount_received"],"properties":{"amount_received":{"type":"integer","format":"int64","description":"The amount received by receiver","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.receiver.oneOf.0.amount_received","typeLabel":"integer\u003cint64>"},"amount_charged":{"oneOf":[{"type":"integer","format":"int64","description":"The amount charged by ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.receiver.oneOf.0.amount_charged.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The amount charged by ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.receiver.oneOf.0.amount_charged.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.receiver.oneOf.0.amount_charged","typeLabel":"integer\u003cint64> | null"},"amount_remaining":{"oneOf":[{"type":"integer","format":"int64","description":"The amount remaining to be sent via ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.receiver.oneOf.0.amount_remaining.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The amount remaining to be sent via ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.receiver.oneOf.0.amount_remaining.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.receiver.oneOf.0.amount_remaining","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.receiver.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.receiver.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0.receiver","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.0","typeLabel":"object"},{"type":"object","required":["ach_credit_transfer"],"properties":{"ach_credit_transfer":{"type":"object","required":["account_number","bank_name","routing_number","swift_code"],"properties":{"account_number":{"type":"string","example":"122385736258","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.ach_credit_transfer.account_number","typeLabel":"string"},"bank_name":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.ach_credit_transfer.bank_name","typeLabel":"string"},"routing_number":{"type":"string","example":"012","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.ach_credit_transfer.routing_number","typeLabel":"string"},"swift_code":{"type":"string","example":"234","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.ach_credit_transfer.swift_code","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.ach_credit_transfer","typeLabel":"object"},"receiver":{"oneOf":[{"type":"object","required":["amount_received"],"properties":{"amount_received":{"type":"integer","format":"int64","description":"The amount received by receiver","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.receiver.oneOf.0.amount_received","typeLabel":"integer\u003cint64>"},"amount_charged":{"oneOf":[{"type":"integer","format":"int64","description":"The amount charged by ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.receiver.oneOf.0.amount_charged.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The amount charged by ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.receiver.oneOf.0.amount_charged.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.receiver.oneOf.0.amount_charged","typeLabel":"integer\u003cint64> | null"},"amount_remaining":{"oneOf":[{"type":"integer","format":"int64","description":"The amount remaining to be sent via ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.receiver.oneOf.0.amount_remaining.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The amount remaining to be sent via ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.receiver.oneOf.0.amount_remaining.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.receiver.oneOf.0.amount_remaining","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.receiver.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.receiver.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1.receiver","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.1","typeLabel":"object"},{"type":"object","required":["sepa_bank_instructions"],"properties":{"sepa_bank_instructions":{"type":"object","required":["account_holder_name","bic","country","iban","reference"],"properties":{"account_holder_name":{"type":"string","example":"Jane Doe","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.sepa_bank_instructions.account_holder_name","typeLabel":"string"},"bic":{"type":"string","example":"9123456789","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.sepa_bank_instructions.bic","typeLabel":"string"},"country":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.sepa_bank_instructions.country","typeLabel":"string"},"iban":{"type":"string","example":"123456789","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.sepa_bank_instructions.iban","typeLabel":"string"},"reference":{"type":"string","example":"U2PVVSEV4V9Y","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.sepa_bank_instructions.reference","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.sepa_bank_instructions","typeLabel":"object"},"receiver":{"oneOf":[{"type":"object","required":["amount_received"],"properties":{"amount_received":{"type":"integer","format":"int64","description":"The amount received by receiver","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.receiver.oneOf.0.amount_received","typeLabel":"integer\u003cint64>"},"amount_charged":{"oneOf":[{"type":"integer","format":"int64","description":"The amount charged by ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.receiver.oneOf.0.amount_charged.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The amount charged by ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.receiver.oneOf.0.amount_charged.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.receiver.oneOf.0.amount_charged","typeLabel":"integer\u003cint64> | null"},"amount_remaining":{"oneOf":[{"type":"integer","format":"int64","description":"The amount remaining to be sent via ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.receiver.oneOf.0.amount_remaining.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The amount remaining to be sent via ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.receiver.oneOf.0.amount_remaining.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.receiver.oneOf.0.amount_remaining","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.receiver.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.receiver.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2.receiver","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.2","typeLabel":"object"},{"type":"object","required":["bacs_bank_instructions"],"properties":{"bacs_bank_instructions":{"type":"object","required":["account_holder_name","account_number","sort_code"],"properties":{"account_holder_name":{"type":"string","example":"Jane Doe","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.bacs_bank_instructions.account_holder_name","typeLabel":"string"},"account_number":{"type":"string","example":"10244123908","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.bacs_bank_instructions.account_number","typeLabel":"string"},"sort_code":{"type":"string","example":"012","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.bacs_bank_instructions.sort_code","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.bacs_bank_instructions","typeLabel":"object"},"receiver":{"oneOf":[{"type":"object","required":["amount_received"],"properties":{"amount_received":{"type":"integer","format":"int64","description":"The amount received by receiver","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.receiver.oneOf.0.amount_received","typeLabel":"integer\u003cint64>"},"amount_charged":{"oneOf":[{"type":"integer","format":"int64","description":"The amount charged by ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.receiver.oneOf.0.amount_charged.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The amount charged by ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.receiver.oneOf.0.amount_charged.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.receiver.oneOf.0.amount_charged","typeLabel":"integer\u003cint64> | null"},"amount_remaining":{"oneOf":[{"type":"integer","format":"int64","description":"The amount remaining to be sent via ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.receiver.oneOf.0.amount_remaining.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The amount remaining to be sent via ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.receiver.oneOf.0.amount_remaining.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.receiver.oneOf.0.amount_remaining","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.receiver.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.receiver.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3.receiver","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.3","typeLabel":"object"},{"type":"object","required":["multibanco"],"properties":{"multibanco":{"type":"object","required":["reference","entity"],"properties":{"reference":{"type":"string","example":"122385736258","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.multibanco.reference","typeLabel":"string"},"entity":{"type":"string","example":"12345","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.multibanco.entity","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.multibanco","typeLabel":"object"},"receiver":{"oneOf":[{"type":"object","required":["amount_received"],"properties":{"amount_received":{"type":"integer","format":"int64","description":"The amount received by receiver","isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.receiver.oneOf.0.amount_received","typeLabel":"integer\u003cint64>"},"amount_charged":{"oneOf":[{"type":"integer","format":"int64","description":"The amount charged by ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.receiver.oneOf.0.amount_charged.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The amount charged by ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.receiver.oneOf.0.amount_charged.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.receiver.oneOf.0.amount_charged","typeLabel":"integer\u003cint64> | null"},"amount_remaining":{"oneOf":[{"type":"integer","format":"int64","description":"The amount remaining to be sent via ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.receiver.oneOf.0.amount_remaining.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The amount remaining to be sent via ACH","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.receiver.oneOf.0.amount_remaining.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.receiver.oneOf.0.amount_remaining","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.receiver.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.receiver.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4.receiver","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details.oneOf.4","typeLabel":"object"}],"isRequired":true,"uniqueKey":"next_action.oneOf.1.bank_transfer_steps_and_charges_details","typeLabel":"object"},"type":{"type":"string","enum":["display_bank_transfer_information"],"isRequired":true,"uniqueKey":"next_action.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.1","typeLabel":"object"},{"type":"object","description":"Contains third party sdk session token response","required":["type"],"properties":{"type":{"type":"string","enum":["third_party_sdk_session_token"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.type","typeLabel":"enum\u003cstring>"},"session_token":{"oneOf":[{"type":"object","required":["wallet_name","delayed_session_token","connector","sdk_next_action"],"properties":{"delayed_session_token":{"type":"boolean","description":"Identifier for the delayed session response","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.delayed_session_token","typeLabel":"boolean"},"connector":{"type":"string","description":"The name of the connector","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.connector","typeLabel":"string"},"sdk_next_action":{"type":"object","required":["next_action"],"properties":{"next_action":{"oneOf":[{"type":"string","description":"The next action call is Post Session Tokens","enum":["post_session_tokens"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.sdk_next_action.next_action.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is confirm","enum":["confirm"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.sdk_next_action.next_action.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is sync","enum":["sync"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.sdk_next_action.next_action.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is Complete Authorize","enum":["complete_authorize"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.sdk_next_action.next_action.oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action is to await for a merchant callback","enum":["await_merchant_callback"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.sdk_next_action.next_action.oneOf.4","typeLabel":"enum\u003cstring>"},{"type":"object","required":["deny"],"properties":{"deny":{"type":"object","description":"The next action is to deny the payment with an error message","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.sdk_next_action.next_action.oneOf.5.deny.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.sdk_next_action.next_action.oneOf.5.deny","typeLabel":"object"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.sdk_next_action.next_action.oneOf.5","typeLabel":"object"},{"type":"string","description":"The next action is to perform eligibility check","enum":["eligibility_check"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.sdk_next_action.next_action.oneOf.6","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.sdk_next_action.next_action","typeLabel":"enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · object · enum\u003cstring>"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.sdk_next_action","typeLabel":"object"},"wallet_name":{"type":"string","enum":["google_pay"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0.wallet_name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.0","typeLabel":"object"},{"type":"object","required":["wallet_name","merchant_info","shipping_address_required","email_required","shipping_address_parameters","allowed_payment_methods","transaction_info","delayed_session_token","connector","sdk_next_action"],"properties":{"merchant_info":{"type":"object","required":["merchant_name"],"properties":{"merchant_name":{"type":"string","description":"The name of the merchant that needs to be displayed on Gpay PopUp","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.merchant_info.merchant_name","typeLabel":"string"},"merchant_id":{"oneOf":[{"type":"string","description":"The merchant Identifier that needs to be passed while invoking Gpay SDK","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.merchant_info.merchant_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The merchant Identifier that needs to be passed while invoking Gpay SDK","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.merchant_info.merchant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.merchant_info.merchant_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.merchant_info","typeLabel":"object"},"shipping_address_required":{"type":"boolean","description":"Is shipping address required","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.shipping_address_required","typeLabel":"boolean"},"email_required":{"type":"boolean","description":"Is email required","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.email_required","typeLabel":"boolean"},"shipping_address_parameters":{"type":"object","required":["phone_number_required"],"properties":{"phone_number_required":{"type":"boolean","description":"Is shipping phone number required","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.shipping_address_parameters.phone_number_required","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.shipping_address_parameters","typeLabel":"object"},"allowed_payment_methods":{"type":"array","items":{"type":"object","required":["type","parameters","tokenization_specification"],"properties":{"type":{"type":"string","description":"The type of payment method","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].type","typeLabel":"string"},"parameters":{"type":"object","required":["allowed_auth_methods","allowed_card_networks"],"properties":{"allowed_auth_methods":{"type":"array","items":{"type":"string","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.allowed_auth_methods.items.[INDEX]","typeLabel":"string"},"description":"The list of allowed auth methods (ex: 3DS, No3DS, PAN_ONLY etc)","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.allowed_auth_methods","typeLabel":"string[]"},"allowed_card_networks":{"type":"array","items":{"type":"string","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.allowed_card_networks.items.[INDEX]","typeLabel":"string"},"description":"The list of allowed card networks (ex: AMEX,JCB etc)","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.allowed_card_networks","typeLabel":"string[]"},"billing_address_required":{"oneOf":[{"type":"boolean","description":"Is billing address required","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_required.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Is billing address required","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_required","typeLabel":"boolean | null"},"billing_address_parameters":{"oneOf":[{"type":"object","required":["phone_number_required","format"],"properties":{"phone_number_required":{"type":"boolean","description":"Is billing phone number required","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_parameters.oneOf.0.phone_number_required","typeLabel":"boolean"},"format":{"type":"string","enum":["FULL","MIN"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_parameters.oneOf.0.format","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_parameters.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_parameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_parameters","typeLabel":"object | null"},"assurance_details_required":{"oneOf":[{"type":"boolean","description":"Whether assurance details are required","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.assurance_details_required.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether assurance details are required","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.assurance_details_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters.assurance_details_required","typeLabel":"boolean | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].parameters","typeLabel":"object"},"tokenization_specification":{"type":"object","required":["type","parameters"],"properties":{"type":{"type":"string","description":"The token specification type(ex: PAYMENT_GATEWAY)","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.type","typeLabel":"string"},"parameters":{"type":"object","properties":{"gateway":{"oneOf":[{"type":"string","description":"The name of the connector","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.gateway.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the connector","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.gateway.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.gateway","typeLabel":"string | null"},"gateway_merchant_id":{"oneOf":[{"type":"string","description":"The merchant ID registered in the connector associated","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.gateway_merchant_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The merchant ID registered in the connector associated","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.gateway_merchant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.gateway_merchant_id","typeLabel":"string | null"},"stripe:version":{"oneOf":[{"type":"string","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.stripe:version.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.stripe:version.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.stripe:version","typeLabel":"string | null"},"stripe:publishableKey":{"oneOf":[{"type":"string","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.stripe:publishableKey.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.stripe:publishableKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.stripe:publishableKey","typeLabel":"string | null"},"protocol_version":{"oneOf":[{"type":"string","description":"The protocol version for encryption","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.protocol_version.oneOf.0","typeLabel":"string"},{"type":"null","description":"The protocol version for encryption","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.protocol_version.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.protocol_version","typeLabel":"string | null"},"public_key":{"oneOf":[{"type":"string","description":"The public key provided by the merchant","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.public_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The public key provided by the merchant","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.public_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.public_key","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters","typeLabel":"object"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification","typeLabel":"object"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods.items.[INDEX]","typeLabel":"object"},"description":"List of the allowed payment methods","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.allowed_payment_methods","typeLabel":"object[]"},"transaction_info":{"type":"object","required":["country_code","currency_code","total_price_status","total_price"],"properties":{"country_code":{"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"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.transaction_info.country_code","typeLabel":"enum\u003cstring>"},"currency_code":{"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":"next_action.oneOf.2.session_token.oneOf.1.transaction_info.currency_code","typeLabel":"enum\u003cstring>"},"total_price_status":{"type":"string","description":"The total price status (ex: 'FINAL')","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.transaction_info.total_price_status","typeLabel":"string"},"total_price":{"type":"string","description":"The total price","example":"38.02","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.transaction_info.total_price","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.transaction_info","typeLabel":"object"},"delayed_session_token":{"type":"boolean","description":"Identifier for the delayed session response","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.delayed_session_token","typeLabel":"boolean"},"connector":{"type":"string","description":"The name of the connector","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.connector","typeLabel":"string"},"sdk_next_action":{"type":"object","required":["next_action"],"properties":{"next_action":{"oneOf":[{"type":"string","description":"The next action call is Post Session Tokens","enum":["post_session_tokens"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.sdk_next_action.next_action.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is confirm","enum":["confirm"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.sdk_next_action.next_action.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is sync","enum":["sync"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.sdk_next_action.next_action.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is Complete Authorize","enum":["complete_authorize"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.sdk_next_action.next_action.oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action is to await for a merchant callback","enum":["await_merchant_callback"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.sdk_next_action.next_action.oneOf.4","typeLabel":"enum\u003cstring>"},{"type":"object","required":["deny"],"properties":{"deny":{"type":"object","description":"The next action is to deny the payment with an error message","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.sdk_next_action.next_action.oneOf.5.deny.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.sdk_next_action.next_action.oneOf.5.deny","typeLabel":"object"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.sdk_next_action.next_action.oneOf.5","typeLabel":"object"},{"type":"string","description":"The next action is to perform eligibility check","enum":["eligibility_check"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.sdk_next_action.next_action.oneOf.6","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.sdk_next_action.next_action","typeLabel":"enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · object · enum\u003cstring>"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.sdk_next_action","typeLabel":"object"},"wallet_name":{"type":"string","enum":["google_pay"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.wallet_name","typeLabel":"enum\u003cstring>"},"secrets":{"oneOf":[{"type":"object","required":["display","payment"],"properties":{"display":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.secrets.oneOf.0.display","typeLabel":"string"},"payment":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.secrets.oneOf.0.payment","typeLabel":"string"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.secrets.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.secrets.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1.secrets","typeLabel":"object | null"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.1","typeLabel":"object"},{"type":"object","required":["wallet_name","version","service_id","order_number","merchant","amount","protocol","allowed_brands","billing_address_required","shipping_address_required"],"properties":{"version":{"type":"string","description":"Samsung Pay API version","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.version","typeLabel":"string"},"service_id":{"type":"string","description":"Samsung Pay service ID to which session call needs to be made","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.service_id","typeLabel":"string"},"order_number":{"type":"string","description":"Order number of the transaction","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.order_number","typeLabel":"string"},"merchant":{"type":"object","required":["name","country_code"],"properties":{"name":{"type":"string","description":"Merchant name, this will be displayed on the Samsung Pay screen","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.merchant.name","typeLabel":"string"},"country_code":{"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"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.merchant.country_code","typeLabel":"enum\u003cstring>"},"url":{"oneOf":[{"type":"string","description":"Merchant domain that process payments, required for web payments","uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.merchant.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant domain that process payments, required for web payments","uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.merchant.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.merchant.url","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.merchant","typeLabel":"object"},"amount":{"type":"object","required":["option","currency_code","total"],"properties":{"option":{"type":"string","enum":["FORMAT_TOTAL_PRICE_ONLY","FORMAT_TOTAL_ESTIMATED_AMOUNT"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.amount.option","typeLabel":"enum\u003cstring>"},"currency_code":{"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":"next_action.oneOf.2.session_token.oneOf.2.amount.currency_code","typeLabel":"enum\u003cstring>"},"total":{"type":"string","description":"The total amount of the transaction","example":"38.02","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.amount.total","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.amount","typeLabel":"object"},"protocol":{"type":"string","enum":["PROTOCOL3DS"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.protocol","typeLabel":"enum\u003cstring>"},"allowed_brands":{"type":"array","items":{"type":"string","uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.allowed_brands.items.[INDEX]","typeLabel":"string"},"description":"List of supported card brands","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.allowed_brands","typeLabel":"string[]"},"billing_address_required":{"type":"boolean","description":"Is billing address required to be collected from wallet","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.billing_address_required","typeLabel":"boolean"},"shipping_address_required":{"type":"boolean","description":"Is shipping address required to be collected from wallet","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.shipping_address_required","typeLabel":"boolean"},"wallet_name":{"type":"string","enum":["samsung_pay"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2.wallet_name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.2","typeLabel":"object"},{"type":"object","required":["wallet_name","session_token","session_id"],"properties":{"session_token":{"type":"string","description":"The session token for Klarna","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.3.session_token","typeLabel":"string"},"session_id":{"type":"string","description":"The identifier for the session","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.3.session_id","typeLabel":"string"},"wallet_name":{"type":"string","enum":["klarna"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.3.wallet_name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.3","typeLabel":"object"},{"type":"object","required":["wallet_name","connector","session_token","sdk_next_action"],"properties":{"connector":{"type":"string","description":"Name of the connector","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.connector","typeLabel":"string"},"session_token":{"type":"string","description":"The session token for PayPal","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.session_token","typeLabel":"string"},"sdk_next_action":{"type":"object","required":["next_action"],"properties":{"next_action":{"oneOf":[{"type":"string","description":"The next action call is Post Session Tokens","enum":["post_session_tokens"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.sdk_next_action.next_action.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is confirm","enum":["confirm"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.sdk_next_action.next_action.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is sync","enum":["sync"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.sdk_next_action.next_action.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is Complete Authorize","enum":["complete_authorize"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.sdk_next_action.next_action.oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action is to await for a merchant callback","enum":["await_merchant_callback"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.sdk_next_action.next_action.oneOf.4","typeLabel":"enum\u003cstring>"},{"type":"object","required":["deny"],"properties":{"deny":{"type":"object","description":"The next action is to deny the payment with an error message","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.sdk_next_action.next_action.oneOf.5.deny.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.sdk_next_action.next_action.oneOf.5.deny","typeLabel":"object"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.sdk_next_action.next_action.oneOf.5","typeLabel":"object"},{"type":"string","description":"The next action is to perform eligibility check","enum":["eligibility_check"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.sdk_next_action.next_action.oneOf.6","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.sdk_next_action.next_action","typeLabel":"enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · object · enum\u003cstring>"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.sdk_next_action","typeLabel":"object"},"wallet_name":{"type":"string","enum":["paypal"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.wallet_name","typeLabel":"enum\u003cstring>"},"client_token":{"oneOf":[{"type":"string","description":"Authorization token used by client to initiate sdk","uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.client_token.oneOf.0","typeLabel":"string"},{"type":"null","description":"Authorization token used by client to initiate sdk","uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.client_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.client_token","typeLabel":"string | null"},"transaction_info":{"oneOf":[{"type":"object","required":["flow","currency_code","total_price"],"properties":{"flow":{"type":"string","enum":["checkout"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.transaction_info.oneOf.0.flow","typeLabel":"enum\u003cstring>"},"currency_code":{"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":"next_action.oneOf.2.session_token.oneOf.4.transaction_info.oneOf.0.currency_code","typeLabel":"enum\u003cstring>"},"total_price":{"type":"string","description":"Total price","example":"38.02","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.transaction_info.oneOf.0.total_price","typeLabel":"string"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.transaction_info.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.transaction_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4.transaction_info","typeLabel":"object | null"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.4","typeLabel":"object"},{"type":"object","required":["wallet_name","connector","delayed_session_token","sdk_next_action"],"properties":{"connector":{"type":"string","description":"The session token is w.r.t this connector","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.connector","typeLabel":"string"},"delayed_session_token":{"type":"boolean","description":"Identifier for the delayed session response","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.delayed_session_token","typeLabel":"boolean"},"sdk_next_action":{"type":"object","required":["next_action"],"properties":{"next_action":{"oneOf":[{"type":"string","description":"The next action call is Post Session Tokens","enum":["post_session_tokens"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.sdk_next_action.next_action.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is confirm","enum":["confirm"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.sdk_next_action.next_action.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is sync","enum":["sync"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.sdk_next_action.next_action.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is Complete Authorize","enum":["complete_authorize"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.sdk_next_action.next_action.oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action is to await for a merchant callback","enum":["await_merchant_callback"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.sdk_next_action.next_action.oneOf.4","typeLabel":"enum\u003cstring>"},{"type":"object","required":["deny"],"properties":{"deny":{"type":"object","description":"The next action is to deny the payment with an error message","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.sdk_next_action.next_action.oneOf.5.deny.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.sdk_next_action.next_action.oneOf.5.deny","typeLabel":"object"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.sdk_next_action.next_action.oneOf.5","typeLabel":"object"},{"type":"string","description":"The next action is to perform eligibility check","enum":["eligibility_check"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.sdk_next_action.next_action.oneOf.6","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.sdk_next_action.next_action","typeLabel":"enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · object · enum\u003cstring>"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.sdk_next_action","typeLabel":"object"},"wallet_name":{"type":"string","enum":["apple_pay"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.wallet_name","typeLabel":"enum\u003cstring>"},"session_token_data":{"oneOf":[{"type":"object","required":["secrets"],"properties":{"secrets":{"type":"object","required":["display","payment"],"properties":{"display":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.0.secrets.display","typeLabel":"string"},"payment":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.0.secrets.payment","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.0.secrets","typeLabel":"object"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.0","typeLabel":"object"},{"type":"object","required":["epoch_timestamp","expires_at","merchant_session_identifier","nonce","merchant_identifier","domain_name","display_name","signature","operational_analytics_identifier","retries","psp_id"],"properties":{"epoch_timestamp":{"type":"integer","format":"int64","description":"Timestamp at which session is requested","minimum":0,"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.1.epoch_timestamp","typeLabel":"integer\u003cint64>"},"expires_at":{"type":"integer","format":"int64","description":"Timestamp at which session expires","minimum":0,"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.1.expires_at","typeLabel":"integer\u003cint64>"},"merchant_session_identifier":{"type":"string","description":"The identifier for the merchant session","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.1.merchant_session_identifier","typeLabel":"string"},"nonce":{"type":"string","description":"Apple pay generated unique ID (UUID) value","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.1.nonce","typeLabel":"string"},"merchant_identifier":{"type":"string","description":"The identifier for the merchant","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.1.merchant_identifier","typeLabel":"string"},"domain_name":{"type":"string","description":"The domain name of the merchant which is registered in Apple Pay","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.1.domain_name","typeLabel":"string"},"display_name":{"type":"string","description":"The name to be displayed on Apple Pay button","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.1.display_name","typeLabel":"string"},"signature":{"type":"string","description":"A string which represents the properties of a payment","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.1.signature","typeLabel":"string"},"operational_analytics_identifier":{"type":"string","description":"The identifier for the operational analytics","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.1.operational_analytics_identifier","typeLabel":"string"},"retries":{"type":"integer","format":"int32","description":"The number of retries to get the session response","minimum":0,"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.1.retries","typeLabel":"integer\u003cint32>"},"psp_id":{"type":"string","description":"The identifier for the connector transaction","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.1.psp_id","typeLabel":"string"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.1","typeLabel":"object"},{"default":null},{"type":"null","default":null,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.3","typeLabel":"null"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data.oneOf.4","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.session_token_data","typeLabel":"object · object · null · null"},"payment_request_data":{"oneOf":[{"type":"object","required":["country_code","currency_code","total"],"properties":{"country_code":{"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"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.country_code","typeLabel":"enum\u003cstring>"},"currency_code":{"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":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.currency_code","typeLabel":"enum\u003cstring>"},"total":{"type":"object","required":["label","amount"],"properties":{"label":{"type":"string","description":"The label must be the name of the merchant.","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.total.label","typeLabel":"string"},"amount":{"type":"string","description":"The total amount for the payment in majot unit string (Ex: 38.02)","example":"38.02","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.total.amount","typeLabel":"string"},"type":{"oneOf":[{"type":"string","description":"A value that indicates whether the line item(Ex: total, tax, discount, or grand total) is final or pending.","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.total.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"A value that indicates whether the line item(Ex: total, tax, discount, or grand total) is final or pending.","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.total.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.total.type","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.total","typeLabel":"object"},"merchant_capabilities":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.merchant_capabilities.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The list of merchant capabilities(ex: whether capable of 3ds or no-3ds)","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.merchant_capabilities.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The list of merchant capabilities(ex: whether capable of 3ds or no-3ds)","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.merchant_capabilities.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.merchant_capabilities","typeLabel":"string[] | null"},"supported_networks":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.supported_networks.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The list of supported networks","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.supported_networks.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The list of supported networks","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.supported_networks.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.supported_networks","typeLabel":"string[] | null"},"merchant_identifier":{"oneOf":[{"type":"string","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.merchant_identifier.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.merchant_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.merchant_identifier","typeLabel":"string | null"},"required_billing_contact_fields":{"oneOf":[{"type":"array","items":{"type":"string","enum":["postalAddress","phone","email"],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.required_billing_contact_fields.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.required_billing_contact_fields.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.required_billing_contact_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.required_billing_contact_fields","typeLabel":"enum\u003cstring>[] | null"},"required_shipping_contact_fields":{"oneOf":[{"type":"array","items":{"type":"string","enum":["postalAddress","phone","email"],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.required_shipping_contact_fields.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.required_shipping_contact_fields.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.required_shipping_contact_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.required_shipping_contact_fields","typeLabel":"enum\u003cstring>[] | null"},"recurring_payment_request":{"oneOf":[{"type":"object","required":["payment_description","regular_billing","management_u_r_l"],"properties":{"payment_description":{"type":"string","description":"A description of the recurring payment that Apple Pay displays to the user in the payment sheet","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.payment_description","typeLabel":"string"},"regular_billing":{"type":"object","required":["amount","label","payment_timing"],"properties":{"amount":{"type":"string","description":"The amount of the recurring payment","example":"38.02","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.amount","typeLabel":"string"},"label":{"type":"string","description":"The label that Apple Pay displays to the user in the payment sheet with the recurring details","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.label","typeLabel":"string"},"payment_timing":{"type":"string","enum":["immediate","recurring"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.payment_timing","typeLabel":"enum\u003cstring>"},"recurring_payment_start_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date of the first payment","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_start_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date of the first payment","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_start_date","typeLabel":"string\u003cdate-time> | null"},"recurring_payment_end_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date of the final payment","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_end_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date of the final payment","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_end_date","typeLabel":"string\u003cdate-time> | null"},"recurring_payment_interval_unit":{"oneOf":[{"type":"string","enum":["year","month","day","hour","minute"],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_interval_unit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_interval_unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_interval_unit","typeLabel":"enum\u003cstring> | null"},"recurring_payment_interval_count":{"oneOf":[{"type":"integer","format":"int32","description":"The number of interval units that make up the total payment interval","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_interval_count.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"The number of interval units that make up the total payment interval","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_interval_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_interval_count","typeLabel":"integer\u003cint32> | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing","typeLabel":"object"},"management_u_r_l":{"type":"string","description":"A URL to a web page where the user can update or delete the payment method for the recurring payment","example":"https://birrpay.io","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.management_u_r_l","typeLabel":"string"},"billing_agreement":{"oneOf":[{"type":"string","description":"A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.billing_agreement.oneOf.0","typeLabel":"string"},{"type":"null","description":"A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.billing_agreement.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.billing_agreement","typeLabel":"string | null"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0.recurring_payment_request","typeLabel":"object | null"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.payment_request_data","typeLabel":"object | null"},"connector_reference_id":{"oneOf":[{"type":"string","description":"The connector transaction id","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.connector_reference_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The connector transaction id","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.connector_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.connector_reference_id","typeLabel":"string | null"},"connector_sdk_public_key":{"oneOf":[{"type":"string","description":"The public key id is to invoke third party sdk","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.connector_sdk_public_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The public key id is to invoke third party sdk","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.connector_sdk_public_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.connector_sdk_public_key","typeLabel":"string | null"},"connector_merchant_id":{"oneOf":[{"type":"string","description":"The connector merchant id","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.connector_merchant_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The connector merchant id","uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.connector_merchant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5.connector_merchant_id","typeLabel":"string | null"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.5","typeLabel":"object"},{"type":"object","required":["wallet_name","open_banking_session_token"],"properties":{"open_banking_session_token":{"type":"string","description":"The session token for OpenBanking Connectors","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.6.open_banking_session_token","typeLabel":"string"},"wallet_name":{"type":"string","enum":["open_banking"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.6.wallet_name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.6","typeLabel":"object"},{"type":"object","required":["wallet_name","client_id","client_name","client_profile_id","transaction_currency_code","transaction_amount"],"properties":{"client_id":{"type":"string","description":"Paze Client ID","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.7.client_id","typeLabel":"string"},"client_name":{"type":"string","description":"Client Name to be displayed on the Paze screen","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.7.client_name","typeLabel":"string"},"client_profile_id":{"type":"string","description":"Paze Client Profile ID","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.7.client_profile_id","typeLabel":"string"},"transaction_currency_code":{"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":"next_action.oneOf.2.session_token.oneOf.7.transaction_currency_code","typeLabel":"enum\u003cstring>"},"transaction_amount":{"type":"string","description":"The transaction amount","example":"38.02","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.7.transaction_amount","typeLabel":"string"},"wallet_name":{"type":"string","enum":["paze"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.7.wallet_name","typeLabel":"enum\u003cstring>"},"email_address":{"oneOf":[{"type":"string","description":"Email Address","example":"[email protected]","maxLength":255,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.7.email_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email Address","example":"[email protected]","maxLength":255,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.7.email_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.7.email_address","typeLabel":"string | null"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.7","typeLabel":"object"},{"type":"object","required":["wallet_name","dpa_id","dpa_name","locale","card_brands","acquirer_bin","acquirer_merchant_id","merchant_country_code","transaction_amount","transaction_currency_code"],"properties":{"dpa_id":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.dpa_id","typeLabel":"string"},"dpa_name":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.dpa_name","typeLabel":"string"},"locale":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.locale","typeLabel":"string"},"card_brands":{"type":"array","items":{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce"],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.card_brands.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":"[Visa, Mastercard]","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.card_brands","typeLabel":"enum\u003cstring>[]"},"acquirer_bin":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.acquirer_bin","typeLabel":"string"},"acquirer_merchant_id":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.acquirer_merchant_id","typeLabel":"string"},"merchant_country_code":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.merchant_country_code","typeLabel":"string"},"transaction_amount":{"type":"string","example":"38.02","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.transaction_amount","typeLabel":"string"},"transaction_currency_code":{"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":"next_action.oneOf.2.session_token.oneOf.8.transaction_currency_code","typeLabel":"enum\u003cstring>"},"wallet_name":{"type":"string","enum":["click_to_pay"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.wallet_name","typeLabel":"enum\u003cstring>"},"merchant_category_code":{"oneOf":[{"type":"string","uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.merchant_category_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.merchant_category_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.merchant_category_code","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","example":"9123456789","maxLength":255,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.phone_number.oneOf.0","typeLabel":"string"},{"type":"null","example":"9123456789","maxLength":255,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.phone_number","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","example":"[email protected]","maxLength":255,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.email.oneOf.0","typeLabel":"string"},{"type":"null","example":"[email protected]","maxLength":255,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.email","typeLabel":"string | null"},"phone_country_code":{"oneOf":[{"type":"string","uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.phone_country_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.phone_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.phone_country_code","typeLabel":"string | null"},"provider":{"oneOf":[{"type":"string","enum":["visa","mastercard"],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.provider.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.provider","typeLabel":"enum\u003cstring> | null"},"dpa_client_id":{"oneOf":[{"type":"string","uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.dpa_client_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.dpa_client_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8.dpa_client_id","typeLabel":"string | null"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.8","typeLabel":"object"},{"type":"object","required":["wallet_name","merchant_id","ledger_currency","store_id","payment_intent","total_shipping_amount","total_tax_amount","total_base_amount","delivery_options"],"properties":{"merchant_id":{"type":"string","description":"Amazon Pay merchant account identifier","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.merchant_id","typeLabel":"string"},"ledger_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":"next_action.oneOf.2.session_token.oneOf.9.ledger_currency","typeLabel":"enum\u003cstring>"},"store_id":{"type":"string","description":"Amazon Pay store ID","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.store_id","typeLabel":"string"},"payment_intent":{"type":"string","enum":["Confirm","Authorize","AuthorizeWithCapture"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.payment_intent","typeLabel":"enum\u003cstring>"},"total_shipping_amount":{"type":"string","description":"The total shipping costs","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.total_shipping_amount","typeLabel":"string"},"total_tax_amount":{"type":"string","description":"The total tax amount for the order","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.total_tax_amount","typeLabel":"string"},"total_base_amount":{"type":"string","description":"The total amount for items in the cart","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.total_base_amount","typeLabel":"string"},"delivery_options":{"type":"array","items":{"type":"object","required":["id","price","shipping_method","is_default"],"properties":{"id":{"type":"string","description":"Delivery Option identifier","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.delivery_options.items.[INDEX].id","typeLabel":"string"},"price":{"type":"object","required":["amount","currency_code"],"properties":{"amount":{"type":"integer","format":"int64","description":"This Unit struct represents MinorUnit in which core amount works","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.delivery_options.items.[INDEX].price.amount","typeLabel":"integer\u003cint64>"},"currency_code":{"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":"next_action.oneOf.2.session_token.oneOf.9.delivery_options.items.[INDEX].price.currency_code","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.delivery_options.items.[INDEX].price","typeLabel":"object"},"shipping_method":{"type":"object","required":["shipping_method_name","shipping_method_code"],"properties":{"shipping_method_name":{"type":"string","description":"Name of the shipping method","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.delivery_options.items.[INDEX].shipping_method.shipping_method_name","typeLabel":"string"},"shipping_method_code":{"type":"string","description":"Code of the shipping method","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.delivery_options.items.[INDEX].shipping_method.shipping_method_code","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.delivery_options.items.[INDEX].shipping_method","typeLabel":"object"},"is_default":{"type":"boolean","description":"Specifies if this delivery option is the default","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.delivery_options.items.[INDEX].is_default","typeLabel":"boolean"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.delivery_options.items.[INDEX]","typeLabel":"object"},"description":"The delivery options available for the provided address","isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.delivery_options","typeLabel":"object[]"},"wallet_name":{"type":"string","enum":["amazon_pay"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9.wallet_name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.9","typeLabel":"object"},{"type":"object","required":["wallet_name"],"properties":{"wallet_name":{"type":"string","enum":["no_session_token_received"],"isRequired":true,"uniqueKey":"next_action.oneOf.2.session_token.oneOf.10.wallet_name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.2.session_token.oneOf.10","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.2.session_token.oneOf.11","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.2.session_token","typeLabel":"object · object · object · object · object · object · object · object · object · object · object · null"}},"uniqueKey":"next_action.oneOf.2","typeLabel":"object"},{"type":"object","description":"Contains url for Qr code image, this qr code has to be shown in sdk","required":["image_data_url","qr_code_url","type"],"properties":{"image_data_url":{"type":"string","description":"BirrPay generated image data source url","isRequired":true,"uniqueKey":"next_action.oneOf.3.image_data_url","typeLabel":"string"},"qr_code_url":{"type":"string","description":"The url for Qr code given by the connector","isRequired":true,"uniqueKey":"next_action.oneOf.3.qr_code_url","typeLabel":"string"},"type":{"type":"string","enum":["qr_code_information"],"isRequired":true,"uniqueKey":"next_action.oneOf.3.type","typeLabel":"enum\u003cstring>"},"display_to_timestamp":{"oneOf":[{"type":"integer","format":"int64","uniqueKey":"next_action.oneOf.3.display_to_timestamp.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","uniqueKey":"next_action.oneOf.3.display_to_timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.3.display_to_timestamp","typeLabel":"integer\u003cint64> | null"},"display_text":{"oneOf":[{"type":"string","uniqueKey":"next_action.oneOf.3.display_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"next_action.oneOf.3.display_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.3.display_text","typeLabel":"string | null"},"border_color":{"oneOf":[{"type":"string","uniqueKey":"next_action.oneOf.3.border_color.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"next_action.oneOf.3.border_color.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.3.border_color","typeLabel":"string | null"}},"uniqueKey":"next_action.oneOf.3","typeLabel":"object"},{"type":"object","description":"Contains url to fetch Qr code data","required":["qr_code_fetch_url","type"],"properties":{"qr_code_fetch_url":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.4.qr_code_fetch_url","typeLabel":"string"},"type":{"type":"string","enum":["fetch_qr_code_information"],"isRequired":true,"uniqueKey":"next_action.oneOf.4.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.4","typeLabel":"object"},{"type":"object","required":["sdk_uri","display_from_timestamp","type"],"properties":{"sdk_uri":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.5.sdk_uri","typeLabel":"string"},"display_from_timestamp":{"type":"integer","isRequired":true,"uniqueKey":"next_action.oneOf.5.display_from_timestamp","typeLabel":"integer"},"type":{"type":"string","enum":["invoke_upi_intent_sdk"],"isRequired":true,"uniqueKey":"next_action.oneOf.5.type","typeLabel":"enum\u003cstring>"},"display_to_timestamp":{"oneOf":[{"type":"integer","uniqueKey":"next_action.oneOf.5.display_to_timestamp.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"next_action.oneOf.5.display_to_timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.5.display_to_timestamp","typeLabel":"integer | null"},"poll_config":{"oneOf":[{"type":"object","required":["delay_in_secs","frequency"],"properties":{"delay_in_secs":{"type":"integer","format":"int32","description":"Interval of the poll","minimum":0,"isRequired":true,"uniqueKey":"next_action.oneOf.5.poll_config.oneOf.0.delay_in_secs","typeLabel":"integer\u003cint32>"},"frequency":{"type":"integer","format":"int32","description":"Frequency of the poll","minimum":0,"isRequired":true,"uniqueKey":"next_action.oneOf.5.poll_config.oneOf.0.frequency","typeLabel":"integer\u003cint32>"}},"uniqueKey":"next_action.oneOf.5.poll_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.5.poll_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.5.poll_config","typeLabel":"object | null"}},"uniqueKey":"next_action.oneOf.5","typeLabel":"object"},{"type":"object","required":["qr_code_url","display_from_timestamp","type"],"properties":{"qr_code_url":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.6.qr_code_url","typeLabel":"string"},"display_from_timestamp":{"type":"integer","isRequired":true,"uniqueKey":"next_action.oneOf.6.display_from_timestamp","typeLabel":"integer"},"type":{"type":"string","enum":["invoke_upi_qr_flow"],"isRequired":true,"uniqueKey":"next_action.oneOf.6.type","typeLabel":"enum\u003cstring>"},"display_to_timestamp":{"oneOf":[{"type":"integer","uniqueKey":"next_action.oneOf.6.display_to_timestamp.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"next_action.oneOf.6.display_to_timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.6.display_to_timestamp","typeLabel":"integer | null"},"poll_config":{"oneOf":[{"type":"object","required":["delay_in_secs","frequency"],"properties":{"delay_in_secs":{"type":"integer","format":"int32","description":"Interval of the poll","minimum":0,"isRequired":true,"uniqueKey":"next_action.oneOf.6.poll_config.oneOf.0.delay_in_secs","typeLabel":"integer\u003cint32>"},"frequency":{"type":"integer","format":"int32","description":"Frequency of the poll","minimum":0,"isRequired":true,"uniqueKey":"next_action.oneOf.6.poll_config.oneOf.0.frequency","typeLabel":"integer\u003cint32>"}},"uniqueKey":"next_action.oneOf.6.poll_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.6.poll_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.6.poll_config","typeLabel":"object | null"}},"uniqueKey":"next_action.oneOf.6","typeLabel":"object"},{"type":"object","description":"Contains the download url and the reference number for transaction","required":["voucher_details","type"],"properties":{"voucher_details":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.7.voucher_details","typeLabel":"string"},"type":{"type":"string","enum":["display_voucher_information"],"isRequired":true,"uniqueKey":"next_action.oneOf.7.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.7","typeLabel":"object"},{"type":"object","description":"Contains duration for displaying a wait screen, wait screen with timer is displayed by sdk","required":["display_from_timestamp","type"],"properties":{"display_from_timestamp":{"type":"integer","isRequired":true,"uniqueKey":"next_action.oneOf.8.display_from_timestamp","typeLabel":"integer"},"type":{"type":"string","enum":["wait_screen_information"],"isRequired":true,"uniqueKey":"next_action.oneOf.8.type","typeLabel":"enum\u003cstring>"},"display_to_timestamp":{"oneOf":[{"type":"integer","uniqueKey":"next_action.oneOf.8.display_to_timestamp.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"next_action.oneOf.8.display_to_timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.8.display_to_timestamp","typeLabel":"integer | null"},"poll_config":{"oneOf":[{"type":"object","required":["delay_in_secs","frequency"],"properties":{"delay_in_secs":{"type":"integer","format":"int32","description":"Interval of the poll","minimum":0,"isRequired":true,"uniqueKey":"next_action.oneOf.8.poll_config.oneOf.0.delay_in_secs","typeLabel":"integer\u003cint32>"},"frequency":{"type":"integer","format":"int32","description":"Frequency of the poll","minimum":0,"isRequired":true,"uniqueKey":"next_action.oneOf.8.poll_config.oneOf.0.frequency","typeLabel":"integer\u003cint32>"}},"uniqueKey":"next_action.oneOf.8.poll_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.8.poll_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.8.poll_config","typeLabel":"object | null"}},"uniqueKey":"next_action.oneOf.8","typeLabel":"object"},{"type":"object","description":"Contains the information regarding three_ds_method_data submission, three_ds authentication, and authorization flows","required":["three_ds_data","type"],"properties":{"three_ds_data":{"type":"object","required":["three_ds_authentication_url","three_ds_authorize_url","three_ds_method_details","poll_config"],"properties":{"three_ds_authentication_url":{"type":"string","description":"ThreeDS authentication url - to initiate authentication","isRequired":true,"uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_authentication_url","typeLabel":"string"},"three_ds_authorize_url":{"type":"string","description":"ThreeDS authorize url - to complete the payment authorization after authentication","isRequired":true,"uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_authorize_url","typeLabel":"string"},"three_ds_method_details":{"type":"object","required":["three_ds_method_data_submission","consume_post_message_for_three_ds_method_completion"],"properties":{"three_ds_method_data_submission":{"type":"boolean","description":"Whether ThreeDS method data submission is required","isRequired":true,"uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_method_details.three_ds_method_data_submission","typeLabel":"boolean"},"consume_post_message_for_three_ds_method_completion":{"type":"boolean","description":"Indicates whethere to wait for Post message after 3DS method data submission","isRequired":true,"uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_method_details.consume_post_message_for_three_ds_method_completion","typeLabel":"boolean"},"three_ds_method_data":{"oneOf":[{"type":"string","description":"ThreeDS method data","uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_method_details.three_ds_method_data.oneOf.0","typeLabel":"string"},{"type":"null","description":"ThreeDS method data","uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_method_details.three_ds_method_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_method_details.three_ds_method_data","typeLabel":"string | null"},"three_ds_method_url":{"oneOf":[{"type":"string","description":"ThreeDS method url","uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_method_details.three_ds_method_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"ThreeDS method url","uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_method_details.three_ds_method_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_method_details.three_ds_method_url","typeLabel":"string | null"},"three_ds_method_key":{"oneOf":[{"type":"string","enum":["threeDSMethodData","JWT"],"uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_method_details.three_ds_method_key.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_method_details.three_ds_method_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_method_details.three_ds_method_key","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_method_details","typeLabel":"object"},"poll_config":{"type":"object","required":["poll_id","delay_in_secs","frequency"],"properties":{"poll_id":{"type":"string","description":"Poll Id","isRequired":true,"uniqueKey":"next_action.oneOf.9.three_ds_data.poll_config.poll_id","typeLabel":"string"},"delay_in_secs":{"type":"integer","format":"int32","description":"Interval of the poll","isRequired":true,"uniqueKey":"next_action.oneOf.9.three_ds_data.poll_config.delay_in_secs","typeLabel":"integer\u003cint32>"},"frequency":{"type":"integer","format":"int32","description":"Frequency of the poll","isRequired":true,"uniqueKey":"next_action.oneOf.9.three_ds_data.poll_config.frequency","typeLabel":"integer\u003cint32>"}},"isRequired":true,"uniqueKey":"next_action.oneOf.9.three_ds_data.poll_config","typeLabel":"object"},"message_version":{"oneOf":[{"type":"string","description":"Message Version","uniqueKey":"next_action.oneOf.9.three_ds_data.message_version.oneOf.0","typeLabel":"string"},{"type":"null","description":"Message Version","uniqueKey":"next_action.oneOf.9.three_ds_data.message_version.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.9.three_ds_data.message_version","typeLabel":"string | null"},"directory_server_id":{"oneOf":[{"type":"string","description":"Directory Server ID","uniqueKey":"next_action.oneOf.9.three_ds_data.directory_server_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Directory Server ID","uniqueKey":"next_action.oneOf.9.three_ds_data.directory_server_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.9.three_ds_data.directory_server_id","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":"next_action.oneOf.9.three_ds_data.card_network.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"next_action.oneOf.9.three_ds_data.card_network.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.9.three_ds_data.card_network","typeLabel":"enum\u003cstring> | null"},"three_ds_connector":{"oneOf":[{"type":"string","description":"Prefered 3ds Connector","uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_connector.oneOf.0","typeLabel":"string"},{"type":"null","description":"Prefered 3ds Connector","uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_connector.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.9.three_ds_data.three_ds_connector","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.9.three_ds_data","typeLabel":"object"},"type":{"type":"string","enum":["three_ds_invoke"],"isRequired":true,"uniqueKey":"next_action.oneOf.9.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.9","typeLabel":"object"},{"type":"object","required":["next_action_data","type"],"properties":{"next_action_data":{"type":"object","required":["next_action"],"properties":{"next_action":{"oneOf":[{"type":"string","description":"The next action call is Post Session Tokens","enum":["post_session_tokens"],"isRequired":true,"uniqueKey":"next_action.oneOf.10.next_action_data.next_action.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is confirm","enum":["confirm"],"isRequired":true,"uniqueKey":"next_action.oneOf.10.next_action_data.next_action.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is sync","enum":["sync"],"isRequired":true,"uniqueKey":"next_action.oneOf.10.next_action_data.next_action.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action call is Complete Authorize","enum":["complete_authorize"],"isRequired":true,"uniqueKey":"next_action.oneOf.10.next_action_data.next_action.oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The next action is to await for a merchant callback","enum":["await_merchant_callback"],"isRequired":true,"uniqueKey":"next_action.oneOf.10.next_action_data.next_action.oneOf.4","typeLabel":"enum\u003cstring>"},{"type":"object","required":["deny"],"properties":{"deny":{"type":"object","description":"The next action is to deny the payment with an error message","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"next_action.oneOf.10.next_action_data.next_action.oneOf.5.deny.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"next_action.oneOf.10.next_action_data.next_action.oneOf.5.deny","typeLabel":"object"}},"isRequired":true,"uniqueKey":"next_action.oneOf.10.next_action_data.next_action.oneOf.5","typeLabel":"object"},{"type":"string","description":"The next action is to perform eligibility check","enum":["eligibility_check"],"isRequired":true,"uniqueKey":"next_action.oneOf.10.next_action_data.next_action.oneOf.6","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"next_action.oneOf.10.next_action_data.next_action","typeLabel":"enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · object · enum\u003cstring>"},"order_id":{"oneOf":[{"type":"string","uniqueKey":"next_action.oneOf.10.next_action_data.order_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"next_action.oneOf.10.next_action_data.order_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.10.next_action_data.order_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.10.next_action_data","typeLabel":"object"},"type":{"type":"string","enum":["invoke_sdk_client"],"isRequired":true,"uniqueKey":"next_action.oneOf.10.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.10","typeLabel":"object"},{"type":"object","description":"Contains consent to collect otp for mobile payment","required":["consent_data_required","type"],"properties":{"consent_data_required":{"type":"string","enum":["consent_required","consent_not_required","consent_optional"],"isRequired":true,"uniqueKey":"next_action.oneOf.11.consent_data_required","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["collect_otp"],"isRequired":true,"uniqueKey":"next_action.oneOf.11.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.11","typeLabel":"object"},{"type":"object","description":"Contains data required to invoke hidden iframe","required":["iframe_data","type"],"properties":{"iframe_data":{"type":"object","required":["three_ds_method_url","three_ds_method_data_submission","directory_server_id","method_key"],"properties":{"three_ds_method_url":{"type":"string","description":"ThreeDS method url","isRequired":true,"uniqueKey":"next_action.oneOf.12.iframe_data.three_ds_method_url","typeLabel":"string"},"three_ds_method_data_submission":{"type":"boolean","description":"Whether ThreeDS method data submission is required","isRequired":true,"uniqueKey":"next_action.oneOf.12.iframe_data.three_ds_method_data_submission","typeLabel":"boolean"},"directory_server_id":{"type":"string","description":"ThreeDS Server ID","isRequired":true,"uniqueKey":"next_action.oneOf.12.iframe_data.directory_server_id","typeLabel":"string"},"method_key":{"type":"string","enum":["threeDSMethodData"],"isRequired":true,"uniqueKey":"next_action.oneOf.12.iframe_data.method_key","typeLabel":"enum\u003cstring>"},"three_ds_method_data":{"oneOf":[{"type":"string","description":"ThreeDS method data","uniqueKey":"next_action.oneOf.12.iframe_data.three_ds_method_data.oneOf.0","typeLabel":"string"},{"type":"null","description":"ThreeDS method data","uniqueKey":"next_action.oneOf.12.iframe_data.three_ds_method_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.12.iframe_data.three_ds_method_data","typeLabel":"string | null"},"message_version":{"oneOf":[{"type":"string","description":"ThreeDS Protocol version","uniqueKey":"next_action.oneOf.12.iframe_data.message_version.oneOf.0","typeLabel":"string"},{"type":"null","description":"ThreeDS Protocol version","uniqueKey":"next_action.oneOf.12.iframe_data.message_version.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_action.oneOf.12.iframe_data.message_version","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"next_action.oneOf.12.iframe_data","typeLabel":"object"},"type":{"type":"string","enum":["invoke_hidden_iframe"],"isRequired":true,"uniqueKey":"next_action.oneOf.12.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"next_action.oneOf.12","typeLabel":"object"},{"type":"null","uniqueKey":"next_action.oneOf.13","typeLabel":"null"}],"uniqueKey":"next_action","typeLabel":"object · object · object · object · object · object · object · object · object · object · object · object · object · null"},"authentication_details":{"oneOf":[{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Represents the overall status of a payment intent.\nThe status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).","enum":["succeeded","failed","cancelled","cancelled_post_capture","processing","requires_customer_action","requires_merchant_action","requires_payment_method","requires_confirmation","requires_capture","partially_captured","partially_captured_and_capturable","partially_authorized_and_requires_capture","partially_captured_and_processing","conflicted","expired"],"isRequired":true,"uniqueKey":"authentication_details.oneOf.0.status","typeLabel":"enum\u003cstring>"},"error":{"oneOf":[{"type":"object","description":"Error details for the payment","required":["code","message"],"properties":{"code":{"type":"string","description":"The error code","example":"card_declined","isRequired":true,"uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","description":"The error message","example":"The card was declined.","isRequired":true,"uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.message","typeLabel":"string"},"reason":{"oneOf":[{"type":"string","description":"The detailed error reason that was returned by the connector.","example":"The card was declined.","uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The detailed error reason that was returned by the connector.","example":"The card was declined.","uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.reason","typeLabel":"string | null"},"unified_code":{"oneOf":[{"type":"string","description":"The unified error code across all connectors.\nThis can be relied upon for taking decisions based on the error.","example":"card_declined","uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.unified_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unified error code across all connectors.\nThis can be relied upon for taking decisions based on the error.","example":"card_declined","uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.unified_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.unified_code","typeLabel":"string | null"},"unified_message":{"oneOf":[{"type":"string","description":"The unified error message across all connectors.\nIf there is a translation available, this will have the translated message","example":"The card was declined.","uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.unified_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unified error message across all connectors.\nIf there is a translation available, this will have the translated message","example":"The card was declined.","uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.unified_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.unified_message","typeLabel":"string | null"},"network_advice_code":{"oneOf":[{"type":"string","description":"This field can be returned for both approved and refused Mastercard payments.\nThis code provides additional information about the type of transaction or the reason why the payment failed.\nIf the payment failed, the network advice code gives guidance on if and when you can retry the payment.","example":"01","uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.network_advice_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"This field can be returned for both approved and refused Mastercard payments.\nThis code provides additional information about the type of transaction or the reason why the payment failed.\nIf the payment failed, the network advice code gives guidance on if and when you can retry the payment.","example":"01","uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.network_advice_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.network_advice_code","typeLabel":"string | null"},"network_decline_code":{"oneOf":[{"type":"string","description":"For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.","example":"05","uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.network_decline_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.","example":"05","uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.network_decline_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.network_decline_code","typeLabel":"string | null"},"network_error_message":{"oneOf":[{"type":"string","description":"A string indicating how to proceed with an network error if payment gateway provide one. This is used to understand the network error code better.","example":"Do not retry","uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.network_error_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"A string indicating how to proceed with an network error if payment gateway provide one. This is used to understand the network error code better.","example":"Do not retry","uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.network_error_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_details.oneOf.0.error.oneOf.0.network_error_message","typeLabel":"string | null"}},"uniqueKey":"authentication_details.oneOf.0.error.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"authentication_details.oneOf.0.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_details.oneOf.0.error","typeLabel":"object | null"}},"uniqueKey":"authentication_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"authentication_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_details","typeLabel":"object | null"},"associated_payment_methods":{"oneOf":[{"type":"array","items":{"type":"object","description":"Details of associated payment methods for Payment Methods Session","required":["payment_method_token"],"properties":{"payment_method_token":{"type":"object","description":"Token type for Payment Method Session associated payment methods","required":["type","data"],"properties":{"type":{"type":"string","enum":["payment_method_session_token"],"isRequired":true,"uniqueKey":"associated_payment_methods.oneOf.0.items.[INDEX].payment_method_token.type","typeLabel":"enum\u003cstring>"},"data":{"type":"string","description":"Payment Method Session Token","example":"token_9wcXDRVkfEtLEsSnYKgQ","isRequired":true,"uniqueKey":"associated_payment_methods.oneOf.0.items.[INDEX].payment_method_token.data","typeLabel":"string"}},"isRequired":true,"uniqueKey":"associated_payment_methods.oneOf.0.items.[INDEX].payment_method_token","typeLabel":"object"}},"uniqueKey":"associated_payment_methods.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"The payment method that was created using this payment method session","uniqueKey":"associated_payment_methods.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Details of associated payment methods for Payment Methods Session","required":["payment_method_token"],"properties":{"payment_method_token":{"type":"object","description":"Token type for Payment Method Session associated payment methods","required":["type","data"],"properties":{"type":{"type":"string","enum":["payment_method_session_token"]},"data":{"type":"string","description":"Payment Method Session Token","example":"token_9wcXDRVkfEtLEsSnYKgQ"}}}}},"description":"The payment method that was created using this payment method session","uniqueKey":"associated_payment_methods.oneOf.1","typeLabel":"null"}],"uniqueKey":"associated_payment_methods","typeLabel":"object[] | null"},"associated_token_id":{"oneOf":[{"type":"string","description":"The token-id created if there is tokenization_data present","example":"12345_tok_01926c58bc6e77c09e809964e72af8c8","uniqueKey":"associated_token_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The token-id created if there is tokenization_data present","example":"12345_tok_01926c58bc6e77c09e809964e72af8c8","uniqueKey":"associated_token_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"associated_token_id","typeLabel":"string | null"},"storage_type":{"oneOf":[{"type":"string","enum":["volatile","persistent"],"uniqueKey":"storage_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"storage_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"storage_type","typeLabel":"enum\u003cstring> | null"},"card_cvc_token_storage":{"oneOf":[{"type":"object","required":["is_stored"],"properties":{"is_stored":{"type":"boolean","description":"Indicates whether the card cvc is stored or not","example":true,"isRequired":true,"uniqueKey":"card_cvc_token_storage.oneOf.0.is_stored","typeLabel":"boolean"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"A timestamp (ISO 8601 code) that determines expiry for stored card cvc token","example":"2024-02-24T11:04:09.922Z","uniqueKey":"card_cvc_token_storage.oneOf.0.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"A timestamp (ISO 8601 code) that determines expiry for stored card cvc token","example":"2024-02-24T11:04:09.922Z","uniqueKey":"card_cvc_token_storage.oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"card_cvc_token_storage.oneOf.0.expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"card_cvc_token_storage.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"card_cvc_token_storage.oneOf.1","typeLabel":"null"}],"uniqueKey":"card_cvc_token_storage","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"12345_pms_01926c58bc6e77c09e809964e72af8c8","expires_at":"2023-01-18T11:04:09.922Z","client_secret":"cs_9wcXDRVkfEtLEsSnYKgQ","customer_id":"12345_cus_01926c58bc6e77c09e809964e72af8c8","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>"},"psp_tokenization":{"tokenization_type":"single_use","connector_id":"mca_28a7367sad8239s67"},"network_tokenization":{"enable":"Enable"},"tokenization_data":"\u003cunknown>","return_url":"https://merchant-website.com/return","next_action":{"redirect_to_url":"https://example.com/redirect","type":"redirect_to_url"},"authentication_details":{"status":"succeeded","error":{"code":"card_declined","message":"The card was declined.","reason":"The card was declined.","unified_code":"card_declined","unified_message":"The card was declined.","network_advice_code":"01","network_decline_code":"05","network_error_message":"Do not retry"}},"associated_payment_methods":[{"payment_method_token":{"type":"payment_method_session_token","data":"token_9wcXDRVkfEtLEsSnYKgQ"}}],"associated_token_id":"12345_tok_01926c58bc6e77c09e809964e72af8c8","storage_type":"volatile","card_cvc_token_storage":{"is_stored":true,"expires_at":"2024-02-24T11:04:09.922Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"f432d6e5-b493-42a2-bf5e-f2c9e69d26b0":{"description":"The request is invalid","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"3639ffe4-ff32-426a-9bbc-53748b60deb5":{"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 Session - Create - BirrPay","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/introduction","matchLevel":3},"2.0.0 [BETA]":{"href":"/v2/payment-method-session/payment-method-session--create","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-24T02:55:16.623Z","originalFileLocation":"v2/payment-method-session/payment-method-session--create.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=\"Create a payment method session for a customer This is used to list the saved payment methods for the customer The customer can also add a new payment method using this session\">\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 Session - Create - BirrPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a payment method session for a customer This is used to list the saved payment methods for the customer The customer can also add a new payment method using this session\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BirrPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birrpay.io/v2/payment-method-session/payment-method-session--create\">\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+Method+Session\u0026amp;title=Payment+Method+Session+-+Create\u0026amp;description=Create+a+payment+method+session+for+a+customer%0AThis+is+used+to+list+the+saved+payment+methods+for+the+customer%0AThe+customer+can+also+add+a+new+payment+method+us\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=c54395827a3211b91bcc02971aae451c66e2032d8e21c0e8a4c7815226debc51\">\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 Session - Create - BirrPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a payment method session for a customer This is used to list the saved payment methods for the customer The customer can also add a new payment method using this session\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Payment+Method+Session\u0026amp;title=Payment+Method+Session+-+Create\u0026amp;description=Create+a+payment+method+session+for+a+customer%0AThis+is+used+to+list+the+saved+payment+methods+for+the+customer%0AThe+customer+can+also+add+a+new+payment+method+us\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=c54395827a3211b91bcc02971aae451c66e2032d8e21c0e8a4c7815226debc51\">\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-method-session/payment-method-session--create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/payment-method-session/payment-method-session--create.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-method-session/payment-method-session--create#webpage\",\"url\":\"https://docs.birrpay.io/v2/payment-method-session/payment-method-session--create\",\"name\":\"Payment Method Session - Create\",\"description\":\"Create a payment method session for a customer This is used to list the saved payment methods for the customer The customer can also add a new payment method using this session\",\"dateModified\":\"2026-01-24T02:55:16.623Z\",\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birrpay.io/v2/payment-method-session/payment-method-session--create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birrpay.io/v2/payment-method-session/payment-method-session--create#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 Method Session - Create\",\"item\":\"https://docs.birrpay.io/v2/payment-method-session/payment-method-session--create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birrpay.io/v2/payment-method-session/payment-method-session--create#apireference\",\"headline\":\"Payment Method Session - Create\",\"name\":\"Payment Method Session - Create\",\"description\":\"Create a payment method session for a customer This is used to list the saved payment methods for the customer The customer can also add a new payment method using this session\",\"url\":\"https://docs.birrpay.io/v2/payment-method-session/payment-method-session--create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birrpay.io/v2/payment-method-session/payment-method-session--create#webpage\"},\"dateModified\":\"2026-01-24T02:55:16.623Z\",\"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","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","description":"Retrieve the payment method session","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 Session - Create - 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"]}