Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by BirrPay’s SDK to initiate these wallets’ SDK.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BirrPay","colors":{"primary":"#4F8EFF","light":"#6BA3FF","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/birrpay/YnpImjYt65LKI-RI/logo/light.svg?fit=max\u0026auto=format\u0026n=YnpImjYt65LKI-RI\u0026q=85\u0026s=410fca5e1e3112fa410bfe0f1bc67731","dark":"https://mintcdn.com/birrpay/541dDB4gOfow0DxB/logo/dark.svg?fit=max\u0026auto=format\u0026n=541dDB4gOfow0DxB\u0026q=85\u0026s=e38313db04f8e480c019afc36f86deed"},"favicon":"/favicon.svg","api":{"openapi":["v1/openapi_spec_v1.json","v2/openapi_spec_v2.json","rust_locker_open_api_spec.yml"]},"background":{"color":{"light":"#FAFBFC","dark":"#1d1d1d"}},"navbar":{"links":[{"href":"https://birrpay.io/contactus","label":"Contact Us"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/birrpay-ethiopia"}},"integrations":{"gtm":{"tagId":"GTM-NQNN2JG5"},"mixpanel":{"projectToken":"b637c4588c180272bf586c5376e524e6"}},"contextual":{"options":["copy","claude","chatgpt","view"]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"birrpay","hasAudioNarration":false,"actualSubdomain":"birrpay","customDomains":["docs.birrpay.io"],"gitSource":{"type":"gitlab","owner":"birrpay","repo":"hyperswitch","projectId":77700133,"deployBranch":"develop","contentDirectory":"api-reference","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21eaf12fb2a99bab92c3fd","collectionId":"e126846c-3fdf-4d9b-8ab0-45d072d25e19","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21eaf12fb2a99bab92c3fd:success","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Documentation","count":183},{"language":"default","tag":"Payments Core APIs","count":53},{"language":"default","tag":"Other APIs","count":35},{"language":"default","tag":"Payments Core APIs [BETA]","count":32},{"language":"default","tag":"Account management APIs","count":28},{"language":"default","tag":"Account management APIs [BETA]","count":27},{"language":"default","tag":"Payments","count":26},{"language":"default","tag":"API Reference","count":24},{"language":"default","tag":"Routing","count":17},{"language":"default","tag":"Payment Methods","count":16}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v1/payments/payments--session-token","slug":"/v1/payments/payments--session-token","pageMetadata":{"openapi":"post /payments/session_tokens","title":"Payments - Session token","description":"Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by BirrPay's SDK to initiate these wallets' SDK.","href":"/v1/payments/payments--session-token","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: \"Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by BirrPay’s SDK to initiate these wallets’ SDK.\"\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 /payments/session_tokens","title":"Payments - Session token","description":"Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by BirrPay's SDK to initiate these wallets' SDK.","href":"/v1/payments/payments--session-token","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payments"],"summary":"Payments - Session token","description":"Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by BirrPay's SDK to initiate these wallets' SDK.","operationId":"Create Session tokens for a Payment","requestBody":"b7f93654-fa89-486f-b62f-8d011e01184a","responses":{"200":"e55fe7d3-b4af-4c59-97b9-7ff78d6773be","400":"824d23e8-d3b6-4539-a392-08e300a77325"},"security":["730970fc-6978-4358-be26-e42e93128e58"],"method":"post","type":"path","servers":["792875b0-3b61-48a0-ab23-731c1218999a"],"path":"/payments/session_tokens","baseUrlOptions":["https://sandbox.birrpay.io"],"title":"Payments - Session token","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["payment_id","client_secret","wallets"],"properties":{"payment_id":{"type":"string","description":"The identifier for the payment","isRequired":true,"uniqueKey":"payment_id","typeLabel":"string"},"client_secret":{"type":"string","description":"This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK","isRequired":true,"uniqueKey":"client_secret","typeLabel":"string"},"wallets":{"type":"array","items":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eps","flexiti","fps","evoucher","giropay","givex","google_pay","go_pay","gcash","ideal","interac","indomaret","klarna","kakao_pay","local_bank_redirect","mandiri_va","knet","mb_way","mobile_pay","momo","momo_atm","multibanco","online_banking_thailand","online_banking_czech_republic","online_banking_finland","online_banking_fpx","online_banking_poland","online_banking_slovakia","oxxo","pago_efectivo","permata_bank_transfer","open_banking_uk","pay_bright","payjustnow","paypal","paze","pix","pay_safe_card","przelewy24","prompt_pay","pse","qris","red_compra","red_pagos","samsung_pay","sepa","sepa_bank_transfer","sepa_guarenteed_debit","skrill","sofort","swish","touch_n_go","trustly","twint","upi_collect","upi_intent","upi_qr","vipps","viet_qr","venmo","walley","we_chat_pay","seven_eleven","lawson","mini_stop","family_mart","seicomart","pay_easy","local_bank_transfer","mifinity","open_banking_pis","direct_carrier_billing","instant_bank_transfer","instant_bank_transfer_finland","instant_bank_transfer_poland","revolut_pay","indonesian_bank_transfer","open_banking","network_token"],"uniqueKey":"wallets.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of the supported wallets","isRequired":true,"uniqueKey":"wallets","typeLabel":"enum\u003cstring>[]"},"merchant_connector_details":{"oneOf":[{"type":"object","description":"Merchant connector details used to make payments.","required":["creds_identifier"],"properties":{"creds_identifier":{"type":"string","description":"Creds Identifier is to uniquely identify the credentials. Do not send any sensitive info, like encoded_data in this field. And do not send the string \"null\".","isRequired":true,"uniqueKey":"merchant_connector_details.oneOf.0.creds_identifier","typeLabel":"string"},"encoded_data":{"oneOf":[{"type":"object","properties":{"connector_account_details":{"oneOf":[{"type":"object","description":"Account details of the Connector. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Useful for storing additional, structured information on an object.","uniqueKey":"merchant_connector_details.oneOf.0.encoded_data.oneOf.0.connector_account_details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Account details of the Connector. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Useful for storing additional, structured information on an object.","uniqueKey":"merchant_connector_details.oneOf.0.encoded_data.oneOf.0.connector_account_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_connector_details.oneOf.0.encoded_data.oneOf.0.connector_account_details","typeLabel":"object | null"},"metadata":{"oneOf":[{"type":"object","description":"Metadata is useful for storing additional, unstructured information on an object.","uniqueKey":"merchant_connector_details.oneOf.0.encoded_data.oneOf.0.metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Metadata is useful for storing additional, unstructured information on an object.","uniqueKey":"merchant_connector_details.oneOf.0.encoded_data.oneOf.0.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_connector_details.oneOf.0.encoded_data.oneOf.0.metadata","typeLabel":"object | null"}},"uniqueKey":"merchant_connector_details.oneOf.0.encoded_data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"merchant_connector_details.oneOf.0.encoded_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_connector_details.oneOf.0.encoded_data","typeLabel":"object | null"}},"uniqueKey":"merchant_connector_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"merchant_connector_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_connector_details","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payment_id":"\u003cstring>","client_secret":"\u003cstring>","wallets":[],"merchant_connector_details":{"creds_identifier":"\u003cstring>","encoded_data":{"connector_account_details":{},"metadata":{}}}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"e55fe7d3-b4af-4c59-97b9-7ff78d6773be":{"description":"Payment session object created or session token was retrieved from wallets","content":{"application/json":{"schema":{"type":"object","required":["payment_id","client_secret","session_token"],"properties":{"payment_id":{"type":"string","description":"The identifier for the payment","isRequired":true,"uniqueKey":"payment_id","typeLabel":"string"},"client_secret":{"type":"string","description":"This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK","isRequired":true,"uniqueKey":"client_secret","typeLabel":"string"},"session_token":{"type":"array","items":{"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":"session_token.items.[INDEX].oneOf.0.delayed_session_token","typeLabel":"boolean"},"connector":{"type":"string","description":"The name of the connector","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.0.sdk_next_action.next_action.oneOf.5.deny.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.0.sdk_next_action.next_action.oneOf.5.deny","typeLabel":"object"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.0.sdk_next_action.next_action.oneOf.6","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.0.sdk_next_action.next_action","typeLabel":"enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · object · enum\u003cstring>"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.0.sdk_next_action","typeLabel":"object"},"wallet_name":{"type":"string","enum":["google_pay"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.0.wallet_name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.merchant_info.merchant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.1.merchant_info.merchant_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.merchant_info","typeLabel":"object"},"shipping_address_required":{"type":"boolean","description":"Is shipping address required","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.shipping_address_required","typeLabel":"boolean"},"email_required":{"type":"boolean","description":"Is email required","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.shipping_address_parameters.phone_number_required","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].parameters.allowed_auth_methods","typeLabel":"string[]"},"allowed_card_networks":{"type":"array","items":{"type":"string","uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_required.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Is billing address required","uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_parameters.oneOf.0.format","typeLabel":"enum\u003cstring>"}},"uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_parameters.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].parameters.billing_address_parameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].parameters.assurance_details_required.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether assurance details are required","uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].parameters.assurance_details_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].parameters.assurance_details_required","typeLabel":"boolean | null"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.gateway.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the connector","uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.gateway.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.gateway_merchant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.gateway_merchant_id","typeLabel":"string | null"},"stripe:version":{"oneOf":[{"type":"string","uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.stripe:version.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.stripe:version.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.stripe:version","typeLabel":"string | null"},"stripe:publishableKey":{"oneOf":[{"type":"string","uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.stripe:publishableKey.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.stripe:publishableKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.protocol_version.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.public_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters.public_key","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification.parameters","typeLabel":"object"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX].tokenization_specification","typeLabel":"object"}},"uniqueKey":"session_token.items.[INDEX].oneOf.1.allowed_payment_methods.items.[INDEX]","typeLabel":"object"},"description":"List of the allowed payment methods","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.transaction_info.currency_code","typeLabel":"enum\u003cstring>"},"total_price_status":{"type":"string","description":"The total price status (ex: 'FINAL')","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.transaction_info.total_price_status","typeLabel":"string"},"total_price":{"type":"string","description":"The total price","example":"38.02","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.transaction_info.total_price","typeLabel":"string"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.transaction_info","typeLabel":"object"},"delayed_session_token":{"type":"boolean","description":"Identifier for the delayed session response","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.delayed_session_token","typeLabel":"boolean"},"connector":{"type":"string","description":"The name of the connector","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.sdk_next_action.next_action.oneOf.5.deny.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.sdk_next_action.next_action.oneOf.5.deny","typeLabel":"object"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.1.sdk_next_action.next_action.oneOf.6","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.sdk_next_action.next_action","typeLabel":"enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · object · enum\u003cstring>"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.sdk_next_action","typeLabel":"object"},"wallet_name":{"type":"string","enum":["google_pay"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.wallet_name","typeLabel":"enum\u003cstring>"},"secrets":{"oneOf":[{"type":"object","required":["display","payment"],"properties":{"display":{"type":"string","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.secrets.oneOf.0.display","typeLabel":"string"},"payment":{"type":"string","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.1.secrets.oneOf.0.payment","typeLabel":"string"}},"uniqueKey":"session_token.items.[INDEX].oneOf.1.secrets.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.1.secrets.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.1.secrets","typeLabel":"object | null"}},"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.2.service_id","typeLabel":"string"},"order_number":{"type":"string","description":"Order number of the transaction","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.2.merchant.country_code","typeLabel":"enum\u003cstring>"},"url":{"oneOf":[{"type":"string","description":"Merchant domain that process payments, required for web payments","uniqueKey":"session_token.items.[INDEX].oneOf.2.merchant.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant domain that process payments, required for web payments","uniqueKey":"session_token.items.[INDEX].oneOf.2.merchant.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.2.merchant.url","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.2.amount.currency_code","typeLabel":"enum\u003cstring>"},"total":{"type":"string","description":"The total amount of the transaction","example":"38.02","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.2.amount.total","typeLabel":"string"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.2.amount","typeLabel":"object"},"protocol":{"type":"string","enum":["PROTOCOL3DS"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.2.protocol","typeLabel":"enum\u003cstring>"},"allowed_brands":{"type":"array","items":{"type":"string","uniqueKey":"session_token.items.[INDEX].oneOf.2.allowed_brands.items.[INDEX]","typeLabel":"string"},"description":"List of supported card brands","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.2.allowed_brands","typeLabel":"string[]"},"billing_address_required":{"type":"boolean","description":"Is billing address required to be collected from wallet","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.2.shipping_address_required","typeLabel":"boolean"},"wallet_name":{"type":"string","enum":["samsung_pay"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.2.wallet_name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.3.session_token","typeLabel":"string"},"session_id":{"type":"string","description":"The identifier for the session","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.3.session_id","typeLabel":"string"},"wallet_name":{"type":"string","enum":["klarna"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.3.wallet_name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.4.connector","typeLabel":"string"},"session_token":{"type":"string","description":"The session token for PayPal","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.4.sdk_next_action.next_action.oneOf.5.deny.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.4.sdk_next_action.next_action.oneOf.5.deny","typeLabel":"object"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.4.sdk_next_action.next_action.oneOf.6","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.4.sdk_next_action.next_action","typeLabel":"enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · object · enum\u003cstring>"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.4.sdk_next_action","typeLabel":"object"},"wallet_name":{"type":"string","enum":["paypal"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.4.wallet_name","typeLabel":"enum\u003cstring>"},"client_token":{"oneOf":[{"type":"string","description":"Authorization token used by client to initiate sdk","uniqueKey":"session_token.items.[INDEX].oneOf.4.client_token.oneOf.0","typeLabel":"string"},{"type":"null","description":"Authorization token used by client to initiate sdk","uniqueKey":"session_token.items.[INDEX].oneOf.4.client_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.4.transaction_info.oneOf.0.currency_code","typeLabel":"enum\u003cstring>"},"total_price":{"type":"string","description":"Total price","example":"38.02","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.4.transaction_info.oneOf.0.total_price","typeLabel":"string"}},"uniqueKey":"session_token.items.[INDEX].oneOf.4.transaction_info.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.4.transaction_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.4.transaction_info","typeLabel":"object | null"}},"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.connector","typeLabel":"string"},"delayed_session_token":{"type":"boolean","description":"Identifier for the delayed session response","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.sdk_next_action.next_action.oneOf.5.deny.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.5.sdk_next_action.next_action.oneOf.5.deny","typeLabel":"object"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.sdk_next_action.next_action.oneOf.6","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.5.sdk_next_action.next_action","typeLabel":"enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · enum\u003cstring> · object · enum\u003cstring>"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.5.sdk_next_action","typeLabel":"object"},"wallet_name":{"type":"string","enum":["apple_pay"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.session_token_data.oneOf.0.secrets.display","typeLabel":"string"},"payment":{"type":"string","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.5.session_token_data.oneOf.0.secrets.payment","typeLabel":"string"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.5.session_token_data.oneOf.0.secrets","typeLabel":"object"}},"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.session_token_data.oneOf.1.nonce","typeLabel":"string"},"merchant_identifier":{"type":"string","description":"The identifier for the merchant","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.session_token_data.oneOf.1.psp_id","typeLabel":"string"}},"uniqueKey":"session_token.items.[INDEX].oneOf.5.session_token_data.oneOf.1","typeLabel":"object"},{"default":null},{"type":"null","default":null,"uniqueKey":"session_token.items.[INDEX].oneOf.5.session_token_data.oneOf.3","typeLabel":"null"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.5.session_token_data.oneOf.4","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.total.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.total.type","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.total","typeLabel":"object"},"merchant_capabilities":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.merchant_capabilities.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.merchant_capabilities","typeLabel":"string[] | null"},"supported_networks":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.supported_networks.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The list of supported networks","uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.supported_networks.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.supported_networks","typeLabel":"string[] | null"},"merchant_identifier":{"oneOf":[{"type":"string","uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.merchant_identifier.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.merchant_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.required_billing_contact_fields.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.required_billing_contact_fields.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.required_billing_contact_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.required_shipping_contact_fields.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.required_shipping_contact_fields.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.required_shipping_contact_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_interval_unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.regular_billing.recurring_payment_interval_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.billing_agreement.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0.billing_agreement","typeLabel":"string | null"}},"uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.recurring_payment_request.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0.recurring_payment_request","typeLabel":"object | null"}},"uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.5.payment_request_data","typeLabel":"object | null"},"connector_reference_id":{"oneOf":[{"type":"string","description":"The connector transaction id","uniqueKey":"session_token.items.[INDEX].oneOf.5.connector_reference_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The connector transaction id","uniqueKey":"session_token.items.[INDEX].oneOf.5.connector_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.5.connector_sdk_public_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The public key id is to invoke third party sdk","uniqueKey":"session_token.items.[INDEX].oneOf.5.connector_sdk_public_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.5.connector_sdk_public_key","typeLabel":"string | null"},"connector_merchant_id":{"oneOf":[{"type":"string","description":"The connector merchant id","uniqueKey":"session_token.items.[INDEX].oneOf.5.connector_merchant_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The connector merchant id","uniqueKey":"session_token.items.[INDEX].oneOf.5.connector_merchant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.5.connector_merchant_id","typeLabel":"string | null"}},"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.6.open_banking_session_token","typeLabel":"string"},"wallet_name":{"type":"string","enum":["open_banking"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.6.wallet_name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.7.client_id","typeLabel":"string"},"client_name":{"type":"string","description":"Client Name to be displayed on the Paze screen","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.7.client_name","typeLabel":"string"},"client_profile_id":{"type":"string","description":"Paze Client Profile ID","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.7.transaction_currency_code","typeLabel":"enum\u003cstring>"},"transaction_amount":{"type":"string","description":"The transaction amount","example":"38.02","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.7.transaction_amount","typeLabel":"string"},"wallet_name":{"type":"string","enum":["paze"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.7.wallet_name","typeLabel":"enum\u003cstring>"},"email_address":{"oneOf":[{"type":"string","description":"Email Address","example":"[email protected]","maxLength":255,"uniqueKey":"session_token.items.[INDEX].oneOf.7.email_address.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email Address","example":"[email protected]","maxLength":255,"uniqueKey":"session_token.items.[INDEX].oneOf.7.email_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.7.email_address","typeLabel":"string | null"}},"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.8.dpa_id","typeLabel":"string"},"dpa_name":{"type":"string","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.8.dpa_name","typeLabel":"string"},"locale":{"type":"string","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.8.card_brands.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":"[Visa, Mastercard]","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.8.card_brands","typeLabel":"enum\u003cstring>[]"},"acquirer_bin":{"type":"string","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.8.acquirer_bin","typeLabel":"string"},"acquirer_merchant_id":{"type":"string","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.8.acquirer_merchant_id","typeLabel":"string"},"merchant_country_code":{"type":"string","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.8.merchant_country_code","typeLabel":"string"},"transaction_amount":{"type":"string","example":"38.02","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.8.transaction_currency_code","typeLabel":"enum\u003cstring>"},"wallet_name":{"type":"string","enum":["click_to_pay"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.8.wallet_name","typeLabel":"enum\u003cstring>"},"merchant_category_code":{"oneOf":[{"type":"string","uniqueKey":"session_token.items.[INDEX].oneOf.8.merchant_category_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.8.merchant_category_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.8.merchant_category_code","typeLabel":"string | null"},"phone_number":{"oneOf":[{"type":"string","example":"9123456789","maxLength":255,"uniqueKey":"session_token.items.[INDEX].oneOf.8.phone_number.oneOf.0","typeLabel":"string"},{"type":"null","example":"9123456789","maxLength":255,"uniqueKey":"session_token.items.[INDEX].oneOf.8.phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.8.phone_number","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","example":"[email protected]","maxLength":255,"uniqueKey":"session_token.items.[INDEX].oneOf.8.email.oneOf.0","typeLabel":"string"},{"type":"null","example":"[email protected]","maxLength":255,"uniqueKey":"session_token.items.[INDEX].oneOf.8.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.8.email","typeLabel":"string | null"},"phone_country_code":{"oneOf":[{"type":"string","uniqueKey":"session_token.items.[INDEX].oneOf.8.phone_country_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.8.phone_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.8.phone_country_code","typeLabel":"string | null"},"provider":{"oneOf":[{"type":"string","enum":["visa","mastercard"],"uniqueKey":"session_token.items.[INDEX].oneOf.8.provider.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.8.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.8.provider","typeLabel":"enum\u003cstring> | null"},"dpa_client_id":{"oneOf":[{"type":"string","uniqueKey":"session_token.items.[INDEX].oneOf.8.dpa_client_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"session_token.items.[INDEX].oneOf.8.dpa_client_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_token.items.[INDEX].oneOf.8.dpa_client_id","typeLabel":"string | null"}},"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.9.ledger_currency","typeLabel":"enum\u003cstring>"},"store_id":{"type":"string","description":"Amazon Pay store ID","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.9.store_id","typeLabel":"string"},"payment_intent":{"type":"string","enum":["Confirm","Authorize","AuthorizeWithCapture"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.9.payment_intent","typeLabel":"enum\u003cstring>"},"total_shipping_amount":{"type":"string","description":"The total shipping costs","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.9.total_shipping_amount","typeLabel":"string"},"total_tax_amount":{"type":"string","description":"The total tax amount for the order","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.9.total_tax_amount","typeLabel":"string"},"total_base_amount":{"type":"string","description":"The total amount for items in the cart","isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.9.delivery_options.items.[INDEX].price.currency_code","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.9.delivery_options.items.[INDEX].shipping_method.shipping_method_code","typeLabel":"string"}},"isRequired":true,"uniqueKey":"session_token.items.[INDEX].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":"session_token.items.[INDEX].oneOf.9.delivery_options.items.[INDEX].is_default","typeLabel":"boolean"}},"uniqueKey":"session_token.items.[INDEX].oneOf.9.delivery_options.items.[INDEX]","typeLabel":"object"},"description":"The delivery options available for the provided address","isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.9.delivery_options","typeLabel":"object[]"},"wallet_name":{"type":"string","enum":["amazon_pay"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.9.wallet_name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"session_token.items.[INDEX].oneOf.9","typeLabel":"object"},{"type":"object","required":["wallet_name"],"properties":{"wallet_name":{"type":"string","enum":["no_session_token_received"],"isRequired":true,"uniqueKey":"session_token.items.[INDEX].oneOf.10.wallet_name","typeLabel":"enum\u003cstring>"}},"uniqueKey":"session_token.items.[INDEX].oneOf.10","typeLabel":"object"}],"uniqueKey":"session_token.items.[INDEX]","typeLabel":"object"},"description":"The list of session token object","isRequired":true,"uniqueKey":"session_token","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payment_id":"\u003cstring>","client_secret":"\u003cstring>","session_token":[{"delayed_session_token":true,"connector":"\u003cstring>","sdk_next_action":{"next_action":"post_session_tokens"},"wallet_name":"google_pay"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"824d23e8-d3b6-4539-a392-08e300a77325":{"description":"Missing mandatory fields","content":{"application/json":{"schema":{"type":"object","required":["error_type","message","code"],"properties":{"error_type":{"type":"string","example":"invalid_request","isRequired":true,"uniqueKey":"error_type","typeLabel":"string"},"message":{"type":"string","example":"Missing required param: {param}","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","example":"IR_04","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error_type":"invalid_request","message":"Missing required param: {param}","code":"IR_04"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"730970fc-6978-4358-be26-e42e93128e58":{"publishable_key":{"type":"apiKey","in":"header","name":"api-key","description":"Publishable keys are a type of keys that can be public and have limited scope of usage.","scopes":[]}}},"servers":{"792875b0-3b61-48a0-ab23-731c1218999a":{"url":"https://sandbox.birrpay.io","description":"Sandbox Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"api-key","description":"Publishable keys are a type of keys that can be public and have limited scope of usage.","scopes":[]},"schema":{"title":"api-key","type":"string","description":"Publishable keys are a type of keys that can be public and have limited scope of usage.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"publishable_key","name":"api-key"}],"title":"publishable_key"}]},"originalFileLocation":"v1/openapi_spec_v1.json"},"subdomain":"birrpay","siteName":"BirrPay","title":"Payments - Session token - BirrPay","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/v1/payments/payments--session-token","matchLevel":0},"2.0.0 [BETA]":{"href":"/v2/payments/payments--session-token","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-01-24T02:55:16.155Z","originalFileLocation":"v1/payments/payments--session-token.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=\"Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by BirrPay\u0026#x27;s SDK to initiate these wallets\u0026#x27; SDK.\">\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=\"Payments - Session token - BirrPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by BirrPay\u0026#x27;s SDK to initiate these wallets\u0026#x27; SDK.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BirrPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birrpay.io/v1/payments/payments--session-token\">\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=Payments\u0026amp;title=Payments+-+Session+token\u0026amp;description=Creates+a+session+object+or+a+session+token+for+wallets+like+Apple+Pay%2C+Google+Pay%2C+etc.+These+tokens+are+used+by+BirrPay%27s+SDK+to+initiate+these+wallets%27+SDK.\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=34d9e67827451e16ec253102c8d31a703f1fd6915bac6af5910b3e66ba8479cd\">\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=\"Payments - Session token - BirrPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by BirrPay\u0026#x27;s SDK to initiate these wallets\u0026#x27; SDK.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Payments+-+Session+token\u0026amp;description=Creates+a+session+object+or+a+session+token+for+wallets+like+Apple+Pay%2C+Google+Pay%2C+etc.+These+tokens+are+used+by+BirrPay%27s+SDK+to+initiate+these+wallets%27+SDK.\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=34d9e67827451e16ec253102c8d31a703f1fd6915bac6af5910b3e66ba8479cd\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BirrPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F8EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.birrpay.io/v1/payments/payments--session-token\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v1/payments/payments--session-token.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.birrpay.io/#organization\",\"name\":\"BirrPay\",\"url\":\"https://docs.birrpay.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/birrpay/YnpImjYt65LKI-RI/logo/light.svg?fit=max\u0026auto=format\u0026n=YnpImjYt65LKI-RI\u0026q=85\u0026s=410fca5e1e3112fa410bfe0f1bc67731\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.birrpay.io#website\",\"name\":\"BirrPay\",\"url\":\"https://docs.birrpay.io\",\"publisher\":{\"@id\":\"https://docs.birrpay.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.birrpay.io/v1/payments/payments--session-token#webpage\",\"url\":\"https://docs.birrpay.io/v1/payments/payments--session-token\",\"name\":\"Payments - Session token\",\"description\":\"Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by BirrPay's SDK to initiate these wallets' SDK.\",\"dateModified\":\"2026-01-24T02:55:16.155Z\",\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birrpay.io/v1/payments/payments--session-token#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birrpay.io/v1/payments/payments--session-token#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments Core APIs\",\"item\":\"https://docs.birrpay.io/v1/payments/setup--instructions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payments\",\"item\":\"https://docs.birrpay.io/v1/payments/payments--create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Payments - Session token\",\"item\":\"https://docs.birrpay.io/v1/payments/payments--session-token\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birrpay.io/v1/payments/payments--session-token#apireference\",\"headline\":\"Payments - Session token\",\"name\":\"Payments - Session token\",\"description\":\"Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by BirrPay's SDK to initiate these wallets' SDK.\",\"url\":\"https://docs.birrpay.io/v1/payments/payments--session-token\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birrpay.io/v1/payments/payments--session-token#webpage\"},\"dateModified\":\"2026-01-24T02:55:16.155Z\",\"publisher\":{\"@id\":\"https://docs.birrpay.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BirrPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"BirrPay","nav":{"global":null,"tabs":[{"tab":"Documentation","versions":[{"version":"1.0.0","groups":[{"group":"Get Started","pages":[{"title":"👋 Welcome to BirrPay API Reference","sidebarTitle":"Introduction","icon":"rectangle-code","iconType":"solid","href":"/introduction","hidden":false}]},{"group":"Essentials","pages":[{"title":"Authentication Types","href":"/essentials/authentication"},{"title":"Error Codes","href":"/essentials/error_codes"},{"title":"Rate Limits","href":"/essentials/rate_limit"},{"title":"Go-live Checklist","href":"/essentials/go-live"}]},{"group":"Payments Core APIs","pages":[{"sidebarTitle":"Setup Instructions","icon":"flag","iconType":"solid","title":null,"href":"/v1/payments/setup--instructions"},{"sidebarTitle":"Payment Flows","icon":"arrows-retweet","iconType":"solid","title":null,"href":"/v1/payments/payment--flows"},{"group":"Payments","pages":[{"openapi":"post /payments","title":"Payments - Create","href":"/v1/payments/payments--create"},{"openapi":"post /payments/{payment_id}","title":"Payments - Update","href":"/v1/payments/payments--update"},{"openapi":"post /payments/{payment_id}/confirm","title":"Payments - Confirm","href":"/v1/payments/payments--confirm"},{"openapi":"get /payments/{payment_id}","title":"Payments - Retrieve","href":"/v1/payments/payments--retrieve"},{"openapi":"post /payments/{payment_id}/cancel","title":"Payments - Cancel","href":"/v1/payments/payments--cancel"},{"openapi":"post /payments/{payment_id}/cancel_post_capture","title":"Payments - Cancel Post Capture","href":"/v1/payments/payments--cancel-post-capture"},{"openapi":"post /payments/{payment_id}/capture","title":"Payments - Capture","href":"/v1/payments/payments--capture"},{"openapi":"post /payments/{payment_id}/incremental_authorization","title":"Payments - Incremental Authorization","href":"/v1/payments/payments--incremental-authorization"},{"openapi":"post /payments/{payment_id}/extend_authorization","title":"Payments - Extended Authorization","description":"Extended authorization is available for payments currently in the `requires_capture` status\nCall this endpoint to increase the authorization validity period","href":"/v1/payments/payments--extend-authorization"},{"openapi":"post /payments/session_tokens","title":"Payments - Session token","href":"/v1/payments/payments--session-token"},{"openapi":"get /payment_link/{payment_link_id}","title":"Payments Link - Retrieve","description":"To retrieve the properties of a Payment Link. This may be used to get the status of a previously initiated payment or next action for an ongoing payment","href":"/v1/payments/payments-link--retrieve"},{"openapi":"get /payments/list","title":"Payments - List","href":"/v1/payments/payments--list"},{"openapi":"post /payments/{payment_id}/3ds/authentication","title":"Payments - External 3DS Authentication","href":"/v1/payments/payments--external-3ds-authentication"},{"openapi":"post /{payment_id}/complete_authorize","title":null,"href":"/v1/payments/payments--complete-authorize"},{"openapi":"post /payments/{payment_id}/update_metadata","title":"Payments - Update Metadata","href":"/v1/payments/payments--update-metadata"},{"openapi":"post /payments/{payment_id}/eligibility","title":"Payments - Submit Eligibility Data","href":"/v1/payments/payments--submit-eligibility-data"}]},{"group":"Payment Methods","pages":[{"openapi":"post /payment_methods","title":"PaymentMethods - Create","href":"/v1/payment-methods/paymentmethods--create"},{"openapi":"get /payment_methods/{method_id}","title":"Payment Method - Retrieve","href":"/v1/payment-methods/payment-method--retrieve"},{"openapi":"post /payment_methods/{method_id}/update","title":"Payment Method - Update","href":"/v1/payment-methods/payment-method--update"},{"openapi":"delete /payment_methods/{method_id}","title":"Payment Method - Delete","href":"/v1/payment-methods/payment-method--delete"},{"openapi":"post /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v1/payment-methods/payment-method--set-default-payment-method-for-customer"},{"openapi":"get /account/payment_methods","title":"List payment methods for a Merchant","href":"/v1/payment-methods/list-payment-methods-for-a-merchant"},{"openapi":"get /customers/payment_methods","title":"List customer saved payment methods for a Payment","href":"/v1/payment-methods/list-customer-saved-payment-methods-for-a-payment"},{"openapi":"get /customers/{customer_id}/payment_methods","title":"List payment methods for a Customer","href":"/v1/payment-methods/list-payment-methods-for-a-customer"},{"openapi":"post /{customer_id}/payment_methods/{payment_method_id}/default","title":"Payment Method - Set Default Payment Method for Customer","href":"/v1/customer-set-default-payment-method/customers--set-default-payment-method"}]},{"group":"Customers","pages":[{"openapi":"post /customers","title":"Customers - Create","href":"/v1/customers/customers--create"},{"openapi":"get /customers/{customer_id}","title":"Customers - Retrieve","href":"/v1/customers/customers--retrieve"},{"openapi":"post /customers/{customer_id}","title":"Customers - Update","href":"/v1/customers/customers--update"},{"openapi":"delete /customers/{customer_id}","title":"Customers - Delete","href":"/v1/customers/customers--delete"},{"openapi":"get /customers/list","title":"Customers - List","href":"/v1/customers/customers--list"}]},{"group":"Mandates","pages":[{"openapi":"post /mandates/revoke/{mandate_id}","title":"Mandates - Revoke Mandate","href":"/v1/mandates/mandates--revoke-mandate"},{"openapi":"get /mandates/{mandate_id}","title":"Mandates - Retrieve Mandate","href":"/v1/mandates/mandates--retrieve-mandate"},{"openapi":"post /customers/{customer_id}/mandates","title":null,"href":"/v1/mandates/mandates--customer-mandates-list"}]},{"group":"Refunds","pages":[{"openapi":"post /refunds","title":"Refunds - Create","href":"/v1/refunds/refunds--create"},{"openapi":"post /refunds/{refund_id}","title":"Refunds - Update","href":"/v1/refunds/refunds--update"},{"openapi":"get /refunds/{refund_id}","title":"Refunds - Retrieve","href":"/v1/refunds/refunds--retrieve"},{"openapi":"post /refunds/list","title":"Refunds - List","href":"/v1/refunds/refunds--list"}]},{"group":"Disputes","pages":[{"openapi":"get /disputes/{dispute_id}","title":"Disputes - Retrieve Dispute","href":"/v1/disputes/disputes--retrieve"},{"openapi":"get /disputes/list","title":"Disputes - List Disputes","href":"/v1/disputes/disputes--list"}]},{"group":"Authentication","pages":[{"openapi":"post /authentication","title":"Authentication - Create","href":"/v1/authentication/authentication--create"},{"openapi":"post /authentication/{authentication_id}/eligibility-check","title":"Authentication - POST Eligibility Check","href":"/v1/authentication/authentication--post-eligibility-check"},{"openapi":"get /authentication/{authentication_id}/eligibility-check","title":"Authentication - GET Eligibility Check","href":"/v1/authentication/authentication--get-eligibility-check"}]},{"group":"Payouts","pages":[{"openapi":"post /payouts/create","title":"Payouts - Create","href":"/v1/payouts/payouts--create"},{"openapi":"post /payouts/{payout_id}","title":"Payouts - Update","href":"/v1/payouts/payouts--update"},{"openapi":"post /payouts/{payout_id}/cancel","title":"Payouts - Cancel","href":"/v1/payouts/payouts--cancel"},{"openapi":"post /payouts/{payout_id}/fulfill","title":"Payouts - Fulfill","href":"/v1/payouts/payouts--fulfill"},{"openapi":"post /payouts/{payout_id}/confirm","title":"Payouts - Confirm","href":"/v1/payouts/payouts--confirm"},{"openapi":"get /payouts/{payout_id}","title":"Payouts - Retrieve","href":"/v1/payouts/payouts--retrieve"},{"openapi":"get /payouts/list","title":"Payouts - List","href":"/v1/payouts/payouts--list"},{"openapi":"post /payouts/filter","title":"Payouts - List available filters","href":"/v1/payouts/payouts--list-filters"},{"openapi":"post /payouts/list","title":"Payouts - List using filters","href":"/v1/payouts/payouts--filter"}]}]},{"group":"Account management APIs","pages":[{"group":"Organization","pages":[{"openapi":"post /organization","title":"Organization - Create","href":"/v1/organization/organization--create"},{"openapi":"get /organization/{id}","title":"Organization - Retrieve","href":"/v1/organization/organization--retrieve"},{"openapi":"put /organization/{id}","title":"Organization - Update","href":"/v1/organization/organization--update"}]},{"group":"Merchant Account","pages":[{"openapi":"post /accounts","title":"Merchant Account - Create","href":"/v1/merchant-account/merchant-account--create"},{"openapi":"get /accounts/{account_id}","title":"Merchant Account - Retrieve","href":"/v1/merchant-account/merchant-account--retrieve"},{"openapi":"post /accounts/{account_id}","title":"Merchant Account - Update","href":"/v1/merchant-account/merchant-account--update"},{"openapi":"delete /accounts/{account_id}","title":"Merchant Account - Delete","href":"/v1/merchant-account/merchant-account--delete"},{"openapi":"post /accounts/{account_id}/kv","title":"Merchant Account - KV Status","href":"/v1/merchant-account/merchant-account--kv-status"}]},{"group":"Business Profile","pages":[{"openapi":"post /account/{account_id}/business_profile","title":"Profile - Create","href":"/v1/business-profile/business-profile--create"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}","title":"Profile - Update","href":"/v1/business-profile/business-profile--update"},{"openapi":"get /account/{account_id}/business_profile/{profile_id}","title":"Profile - Retrieve","href":"/v1/business-profile/business-profile--retrieve"},{"openapi":"delete /account/{account_id}/business_profile/{profile_id}","title":"Profile - Delete","href":"/v1/business-profile/business-profile--delete"},{"openapi":"get /account/{account_id}/business_profile","title":"Profile - List","href":"/v1/business-profile/business-profile--list"}]},{"group":"Platform Account","pages":[{"openapi":"post /user/create_platform","title":"Platform - Create","href":"/v1/platform/platform--create"}]},{"group":"API Key","pages":[{"openapi":"post /api_keys/{merchant_id}","title":"API Key - Create","href":"/v1/api-key/api-key--create"},{"openapi":"get /api_keys/{merchant_id}/{key_id}","title":"API Key - Retrieve","href":"/v1/api-key/api-key--retrieve"},{"openapi":"post /api_keys/{merchant_id}/{key_id}","title":"API Key - Update","href":"/v1/api-key/api-key--update"},{"openapi":"delete /api_keys/{merchant_id}/{key_id}","title":"API Key - Revoke","href":"/v1/api-key/api-key--revoke"},{"openapi":"get /api_keys/{merchant_id}/list","title":"API Key - List","href":"/v1/api-key/api-key--list"}]},{"group":"Merchant Connector Account","pages":[{"openapi":"post /account/{account_id}/connectors","title":"Merchant Connector - Create","href":"/v1/merchant-connector-account/merchant-connector--create"},{"openapi":"get /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Retrieve","href":"/v1/merchant-connector-account/merchant-connector--retrieve"},{"openapi":"post /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Update","href":"/v1/merchant-connector-account/merchant-connector--update"},{"openapi":"delete /account/{account_id}/connectors/{merchant_connector_id}","title":"Merchant Connector - Delete","href":"/v1/merchant-connector-account/merchant-connector--delete"},{"openapi":"get /account/{account_id}/connectors","title":"Merchant Connector - List","href":"/v1/merchant-connector-account/merchant-connector--list"}]},{"group":"GSM (Global Status Mapping)","pages":[{"openapi":"post /gsm","title":"Gsm - Create","href":"/v1/gsm/gsm--create"},{"openapi":"post /gsm/get","title":"Gsm - Get","href":"/v1/gsm/gsm--get"},{"openapi":"post /gsm/update","title":"Gsm - Update","href":"/v1/gsm/gsm--update"},{"openapi":"post /gsm/delete","title":"Gsm - Delete","href":"/v1/gsm/gsm--delete"}]}]},{"group":"Other APIs","pages":[{"group":"Event","pages":[{"openapi":"post /events/{merchant_id}","title":"Events - List","href":"/v1/event/events--list"},{"openapi":"get /events/{merchant_id}/{event_id}/attempts","title":"Events - Delivery Attempt List","href":"/v1/event/events--delivery-attempt-list"},{"openapi":"post /events/{merchant_id}/{event_id}/retry","title":"Events - Manual Retry","href":"/v1/event/events--manual-retry"}]},{"group":"Poll","pages":[{"openapi":"get /poll/status/{poll_id}","title":"Poll - Retrieve Poll Status","href":"/v1/poll/poll--retrieve-poll-status"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklist","title":null,"href":"/v1/blocklist/get-blocklist"},{"openapi":"post /blocklist","title":null,"href":"/v1/blocklist/post-blocklist"},{"openapi":"delete /blocklist","title":null,"href":"/v1/blocklist/delete-blocklist"},{"openapi":"post /blocklist/toggle","title":null,"href":"/v1/blocklist/post-blocklisttoggle"}]},{"group":"Routing","pages":[{"openapi":"get /routing","title":"Routing - List","href":"/v1/routing/routing--list"},{"openapi":"post /routing","title":"Routing - Create","href":"/v1/routing/routing--create"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}/dynamic_routing/success_based/create","title":"Routing - Auth Rate Based","href":"/v1/routing/routing--success-based"},{"openapi":"post /account/{account_id}/business_profile/{profile_id}/dynamic_routing/elimination/create","title":"Routing - Elimination","href":"/v1/routing/routing--elimination"},{"openapi":"get /routing/active","title":"Routing - Retrieve Config","href":"/v1/routing/routing--retrieve-config"},{"openapi":"post /routing/deactivate","title":"Routing - Deactivate","href":"/v1/routing/routing--deactivate"},{"openapi":"get /routing/default","title":"Routing - Retrieve Default Config","href":"/v1/routing/routing--retrieve-default-config"},{"openapi":"post /routing/default","title":"Routing - Update Default Config","href":"/v1/routing/routing--update-default-config"},{"openapi":"get /routing/default/profile","title":"Routing - Retrieve Default For Profile","href":"/v1/routing/routing--retrieve-default-for-profile"},{"openapi":"post /routing/default/profile/{profile_id}","title":"Routing - Update Default For Profile","href":"/v1/routing/routing--update-default-for-profile"},{"openapi":"get /routing/{routing_algorithm_id}","title":"Routing - Retrieve","href":"/v1/routing/routing--retrieve"},{"openapi":"post /routing/{routing_algorithm_id}/activate","title":"Routing - Activate config","href":"/v1/routing/routing--activate-config"},{"openapi":"post /routing/evaluate","title":"Routing - Evaluate","href":"/v1/routing/routing--evaluate"},{"openapi":"post /routing/feedback","title":"Routing - Feedback","href":"/v1/routing/routing--feedback"},{"openapi":"post /routing/rule/evaluate","title":"Routing - Rule Evaluate","href":"/v1/routing/routing--rule-evaluate"}]},{"group":"Relay","pages":[{"openapi":"post /relay","title":"Relay - Create","href":"/v1/relay/relay"},{"openapi":"get /relay/{relay_id}","title":"Relay - Retrieve","href":"/v1/relay/relay--retrieve"}]},{"group":"Schemas","pages":[{"title":null,"href":"/v1/schemas/outgoing--webhook"}]},{"group":"Subscriptions","pages":[{"openapi":"post /subscriptions/create","title":"Subscription - Create","href":"/v1/subscriptions/create"},{"openapi":"post /subscriptions/{subscription_id}/confirm","title":"Subscription - Confirm","href":"/v1/subscriptions/confirm"},{"openapi":"post /subscriptions","title":"Subscription - Create and Confirm","href":"/v1/subscriptions/create-and-confirm"},{"openapi":"put /subscriptions/{subscription_id}/update","title":"Subscription - Update","href":"/v1/subscriptions/update"},{"openapi":"get /subscriptions/{subscription_id}","title":"Subscription - Retrieve","href":"/v1/subscriptions/get"},{"title":"Get plans","href":"/v1/subscriptions/get-plans"},{"openapi":"get /subscriptions/estimate","title":"Subscription - Get Estimate","href":"/v1/subscriptions/estimate"},{"openapi":"post /subscriptions/{subscription_id}/pause","title":"Subscription - Pause Subscription","href":"/v1/subscriptions/pause"},{"openapi":"post /subscriptions/{subscription_id}/resume","title":"Subscription - Resume Subscription","href":"/v1/subscriptions/resume"},{"openapi":"post /subscriptions/{subscription_id}/cancel","title":"Subscription - Cancel Subscription","href":"/v1/subscriptions/cancel"}]}]}]},{"version":"2.0.0 [BETA]","pages":[{"title":"2.0.0 [BETA]","href":"/v2/payments/payments--session-token"}]}]},{"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":"Payments - Session token - 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"]}