Admin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.
Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a value is automatically generated.
A boolean value to indicate if customer shipping details needs to be collected from wallet
connector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)
A boolean value to indicate if customer billing details needs to be collected from wallet
connector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)
A boolean value to indicate if customer shipping details needs to be collected from wallet
connector irrespective of connector required fields (Eg. Apple pay, Google pay etc)
A boolean value to indicate if customer billing details needs to be collected from wallet
connector irrespective of connector required fields (Eg. Apple pay, Google pay etc)
Indicates if the MIT (merchant initiated transaction) payments can be made connector
agnostic, i.e., MITs may be processed through different connector than CIT (customer
initiated transaction) based on the routing rules.
If set to false, MIT will go through the same connector as the CIT.
These key-value pairs are sent as additional custom headers in the outgoing webhook request. It is recommended not to use more than four key-value pairs.
Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a value is automatically generated.
A boolean value to indicate if customer shipping details needs to be collected from wallet
connector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)
A boolean value to indicate if customer billing details needs to be collected from wallet
connector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)
A boolean value to indicate if customer shipping details needs to be collected from wallet
connector irrespective of connector required fields (Eg. Apple pay, Google pay etc)
A boolean value to indicate if customer billing details needs to be collected from wallet
connector irrespective of connector required fields (Eg. Apple pay, Google pay etc)
Indicates if the MIT (merchant initiated transaction) payments can be made connector
agnostic, i.e., MITs may be processed through different connector than CIT (customer
initiated transaction) based on the routing rules.
If set to false, MIT will go through the same connector as the CIT.
Flag to enable Level 2 and Level 3 processing data for card transactions
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BirrPay","colors":{"primary":"#4F8EFF","light":"#6BA3FF","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/birrpay/YnpImjYt65LKI-RI/logo/light.svg?fit=max\u0026auto=format\u0026n=YnpImjYt65LKI-RI\u0026q=85\u0026s=410fca5e1e3112fa410bfe0f1bc67731","dark":"https://mintcdn.com/birrpay/541dDB4gOfow0DxB/logo/dark.svg?fit=max\u0026auto=format\u0026n=541dDB4gOfow0DxB\u0026q=85\u0026s=e38313db04f8e480c019afc36f86deed"},"favicon":"/favicon.svg","api":{"openapi":["v1/openapi_spec_v1.json","v2/openapi_spec_v2.json","rust_locker_open_api_spec.yml"]},"background":{"color":{"light":"#FAFBFC","dark":"#1d1d1d"}},"navbar":{"links":[{"href":"https://birrpay.io/contactus","label":"Contact Us"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/birrpay-ethiopia"}},"integrations":{"gtm":{"tagId":"GTM-NQNN2JG5"},"mixpanel":{"projectToken":"b637c4588c180272bf586c5376e524e6"}},"contextual":{"options":["copy","claude","chatgpt","view"]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"birrpay","hasAudioNarration":false,"actualSubdomain":"birrpay","customDomains":["docs.birrpay.io"],"gitSource":{"type":"gitlab","owner":"birrpay","repo":"hyperswitch","projectId":77700133,"deployBranch":"develop","contentDirectory":"api-reference","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21eaf12fb2a99bab92c3fd","collectionId":"e126846c-3fdf-4d9b-8ab0-45d072d25e19","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21eaf12fb2a99bab92c3fd:success","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Documentation","count":183},{"language":"default","tag":"Payments Core APIs","count":53},{"language":"default","tag":"Other APIs","count":35},{"language":"default","tag":"Payments Core APIs [BETA]","count":32},{"language":"default","tag":"Account management APIs","count":28},{"language":"default","tag":"Account management APIs [BETA]","count":27},{"language":"default","tag":"Payments","count":26},{"language":"default","tag":"API Reference","count":24},{"language":"default","tag":"Routing","count":17},{"language":"default","tag":"Payment Methods","count":16}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v2/profile/profile--update","slug":"/v2/profile/profile--update","pageMetadata":{"openapi":"put /v2/profiles/{id}","title":"Profile - Update","description":"Update the *profile*","href":"/v2/profile/profile--update","hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n em: \"em\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Update the \", _jsx(_components.em, {\n children: \"profile\"\n })]\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":"put /v2/profiles/{id}","title":"Profile - Update","description":"Update the *profile*","href":"/v2/profile/profile--update","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Profile"],"summary":"Profile - Update","description":"Update the *profile*","operationId":"Update a Profile","parameters":["dfbd8f33-aa43-47dc-90b3-d308becff7d0","f5763ee3-2f19-42b1-8e05-9af0bb000a6d"],"requestBody":"99c4e876-603b-4ee0-b217-ef213a9bc380","responses":{"200":"7d7e70b2-682e-416c-a72e-a8973deb9efc","400":"3f2e3952-3ac0-4887-850f-e2b68f950853"},"security":["387988a9-a989-4758-b316-8b929212c2a7"],"method":"put","type":"path","servers":["f37e9e71-e224-445e-b50d-8bb9303c2220"],"path":"/v2/profiles/{id}","baseUrlOptions":["https://sandbox.birrpay.io"],"title":"Profile - Update","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"dfbd8f33-aa43-47dc-90b3-d308becff7d0":{"name":"id","in":"path","description":"The unique identifier for the profile","required":true,"schema":{"type":"string","isRequired":true,"description":"The unique identifier for the profile","uniqueKey":"","typeLabel":"string"}},"f5763ee3-2f19-42b1-8e05-9af0bb000a6d":{"name":"X-Merchant-Id","in":"header","description":"Merchant ID of the profile.","required":true,"schema":{"type":"string","isRequired":true,"description":"Merchant ID of the profile.","uniqueKey":"","typeLabel":"string"},"example":{"X-Merchant-Id":"abc_iG5VNjsN9xuCg7Xx0uWh"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["profile_name"],"properties":{"profile_name":{"type":"string","description":"The name of profile","maxLength":64,"isRequired":true,"uniqueKey":"profile_name","typeLabel":"string"},"return_url":{"oneOf":[{"type":"string","description":"The URL to redirect after the completion of the operation","example":"https://www.example.com/success","maxLength":255,"uniqueKey":"return_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to redirect after the completion of the operation","example":"https://www.example.com/success","maxLength":255,"uniqueKey":"return_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"return_url","typeLabel":"string | null"},"enable_payment_response_hash":{"oneOf":[{"type":"boolean","description":"A boolean value to indicate if payment response hash needs to be enabled","default":true,"example":true,"uniqueKey":"enable_payment_response_hash.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"A boolean value to indicate if payment response hash needs to be enabled","default":true,"example":true,"uniqueKey":"enable_payment_response_hash.oneOf.1","typeLabel":"null"}],"uniqueKey":"enable_payment_response_hash","typeLabel":"boolean | null"},"payment_response_hash_key":{"oneOf":[{"type":"string","description":"Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a value is automatically generated.","uniqueKey":"payment_response_hash_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a value is automatically generated.","uniqueKey":"payment_response_hash_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_response_hash_key","typeLabel":"string | null"},"redirect_to_merchant_with_http_post":{"oneOf":[{"type":"boolean","description":"A boolean value to indicate if redirect to merchant with http post needs to be enabled","default":false,"example":true,"uniqueKey":"redirect_to_merchant_with_http_post.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"A boolean value to indicate if redirect to merchant with http post needs to be enabled","default":false,"example":true,"uniqueKey":"redirect_to_merchant_with_http_post.oneOf.1","typeLabel":"null"}],"uniqueKey":"redirect_to_merchant_with_http_post","typeLabel":"boolean | null"},"webhook_details":{"oneOf":[{"type":"object","required":["payment_statuses_enabled","refund_statuses_enabled"],"properties":{"payment_statuses_enabled":{"type":"array","items":{"type":"string","description":"Represents the overall status of a payment intent.\nThe status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).","enum":["succeeded","failed","cancelled","cancelled_post_capture","processing","requires_customer_action","requires_merchant_action","requires_payment_method","requires_confirmation","requires_capture","partially_captured","partially_captured_and_capturable","partially_authorized_and_requires_capture","partially_captured_and_processing","conflicted","expired"],"uniqueKey":"webhook_details.oneOf.0.payment_statuses_enabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"List of payment statuses that triggers a webhook for payment intents","example":["succeeded","failed","partially_captured","requires_merchant_action"],"isRequired":true,"uniqueKey":"webhook_details.oneOf.0.payment_statuses_enabled","typeLabel":"enum\u003cstring>[]"},"refund_statuses_enabled":{"type":"array","items":{"type":"string","description":"Represents the overall status of a payment intent.\nThe status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).","enum":["succeeded","failed","cancelled","cancelled_post_capture","processing","requires_customer_action","requires_merchant_action","requires_payment_method","requires_confirmation","requires_capture","partially_captured","partially_captured_and_capturable","partially_authorized_and_requires_capture","partially_captured_and_processing","conflicted","expired"],"uniqueKey":"webhook_details.oneOf.0.refund_statuses_enabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"List of refund statuses that triggers a webhook for refunds","example":["success","failure"],"isRequired":true,"uniqueKey":"webhook_details.oneOf.0.refund_statuses_enabled","typeLabel":"enum\u003cstring>[]"},"webhook_version":{"oneOf":[{"type":"string","description":"The version for Webhook","example":"1.0.2","maxLength":255,"uniqueKey":"webhook_details.oneOf.0.webhook_version.oneOf.0","typeLabel":"string"},{"type":"null","description":"The version for Webhook","example":"1.0.2","maxLength":255,"uniqueKey":"webhook_details.oneOf.0.webhook_version.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.webhook_version","typeLabel":"string | null"},"webhook_username":{"oneOf":[{"type":"string","description":"The user name for Webhook login","example":"ekart_retail","maxLength":255,"uniqueKey":"webhook_details.oneOf.0.webhook_username.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user name for Webhook login","example":"ekart_retail","maxLength":255,"uniqueKey":"webhook_details.oneOf.0.webhook_username.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.webhook_username","typeLabel":"string | null"},"webhook_password":{"oneOf":[{"type":"string","description":"The password for Webhook login","example":"ekart@123","maxLength":255,"uniqueKey":"webhook_details.oneOf.0.webhook_password.oneOf.0","typeLabel":"string"},{"type":"null","description":"The password for Webhook login","example":"ekart@123","maxLength":255,"uniqueKey":"webhook_details.oneOf.0.webhook_password.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.webhook_password","typeLabel":"string | null"},"webhook_url":{"oneOf":[{"type":"string","description":"The url for the webhook endpoint","example":"www.ekart.com/webhooks","uniqueKey":"webhook_details.oneOf.0.webhook_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The url for the webhook endpoint","example":"www.ekart.com/webhooks","uniqueKey":"webhook_details.oneOf.0.webhook_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.webhook_url","typeLabel":"string | null"},"payment_created_enabled":{"oneOf":[{"type":"boolean","description":"If this property is true, a webhook message is posted whenever a new payment is created","example":true,"uniqueKey":"webhook_details.oneOf.0.payment_created_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If this property is true, a webhook message is posted whenever a new payment is created","example":true,"uniqueKey":"webhook_details.oneOf.0.payment_created_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.payment_created_enabled","typeLabel":"boolean | null"},"payment_succeeded_enabled":{"oneOf":[{"type":"boolean","description":"If this property is true, a webhook message is posted whenever a payment is successful","example":true,"uniqueKey":"webhook_details.oneOf.0.payment_succeeded_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If this property is true, a webhook message is posted whenever a payment is successful","example":true,"uniqueKey":"webhook_details.oneOf.0.payment_succeeded_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.payment_succeeded_enabled","typeLabel":"boolean | null"},"payment_failed_enabled":{"oneOf":[{"type":"boolean","description":"If this property is true, a webhook message is posted whenever a payment fails","example":true,"uniqueKey":"webhook_details.oneOf.0.payment_failed_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If this property is true, a webhook message is posted whenever a payment fails","example":true,"uniqueKey":"webhook_details.oneOf.0.payment_failed_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.payment_failed_enabled","typeLabel":"boolean | null"},"payout_statuses_enabled":{"oneOf":[{"type":"array","items":{"type":"string","enum":["success","failed","cancelled","initiated","expired","reversed","pending","ineligible","requires_creation","requires_confirmation","requires_payout_method_data","requires_fulfillment","requires_vendor_account_creation"],"uniqueKey":"webhook_details.oneOf.0.payout_statuses_enabled.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"List of payout statuses that triggers a webhook for payouts","example":["success","failed"],"uniqueKey":"webhook_details.oneOf.0.payout_statuses_enabled.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"type":"string","enum":["success","failed","cancelled","initiated","expired","reversed","pending","ineligible","requires_creation","requires_confirmation","requires_payout_method_data","requires_fulfillment","requires_vendor_account_creation"]},"description":"List of payout statuses that triggers a webhook for payouts","example":["success","failed"],"uniqueKey":"webhook_details.oneOf.0.payout_statuses_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.payout_statuses_enabled","typeLabel":"enum\u003cstring>[] | null"}},"additionalProperties":false,"uniqueKey":"webhook_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"webhook_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details","typeLabel":"object | null"},"metadata":{"oneOf":[{"type":"object","description":"Metadata is useful for storing additional, unstructured information on an object.","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Metadata is useful for storing additional, unstructured information on an object.","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"order_fulfillment_time":{"oneOf":[{"type":"integer","format":"int32","description":"Will be used to determine the time till which your payment will be active once the payment session starts","example":900,"minimum":0,"uniqueKey":"order_fulfillment_time.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Will be used to determine the time till which your payment will be active once the payment session starts","example":900,"minimum":0,"uniqueKey":"order_fulfillment_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_fulfillment_time","typeLabel":"integer\u003cint32> | null"},"order_fulfillment_time_origin":{"oneOf":[{"type":"string","enum":["create","confirm"],"uniqueKey":"order_fulfillment_time_origin.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"order_fulfillment_time_origin.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_fulfillment_time_origin","typeLabel":"enum\u003cstring> | null"},"applepay_verified_domains":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"applepay_verified_domains.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Verified Apple Pay domains for a particular profile","uniqueKey":"applepay_verified_domains.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Verified Apple Pay domains for a particular profile","uniqueKey":"applepay_verified_domains.oneOf.1","typeLabel":"null"}],"uniqueKey":"applepay_verified_domains","typeLabel":"string[] | null"},"session_expiry":{"oneOf":[{"type":"integer","format":"int32","description":"Client Secret Default expiry for all payments created under this profile","example":900,"minimum":0,"uniqueKey":"session_expiry.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Client Secret Default expiry for all payments created under this profile","example":900,"minimum":0,"uniqueKey":"session_expiry.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_expiry","typeLabel":"integer\u003cint32> | null"},"payment_link_config":{"oneOf":[{"type":"object","properties":{"theme":{"oneOf":[{"type":"string","description":"custom theme for the payment link","example":"#4E6ADD","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.theme.oneOf.0","typeLabel":"string"},{"type":"null","description":"custom theme for the payment link","example":"#4E6ADD","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.theme","typeLabel":"string | null"},"logo":{"oneOf":[{"type":"string","description":"merchant display logo","example":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"merchant display logo","example":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.logo","typeLabel":"string | null"},"seller_name":{"oneOf":[{"type":"string","description":"Custom merchant name for payment link","example":"hyperswitch","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.seller_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom merchant name for payment link","example":"hyperswitch","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.seller_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.seller_name","typeLabel":"string | null"},"sdk_layout":{"oneOf":[{"type":"string","description":"Custom layout for sdk","example":"accordion","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.sdk_layout.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom layout for sdk","example":"accordion","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.sdk_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.sdk_layout","typeLabel":"string | null"},"display_sdk_only":{"oneOf":[{"type":"boolean","description":"Display only the sdk for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.display_sdk_only.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Display only the sdk for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.display_sdk_only.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.display_sdk_only","typeLabel":"boolean | null"},"enabled_saved_payment_method":{"oneOf":[{"type":"boolean","description":"Enable saved payment method option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.enabled_saved_payment_method.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable saved payment method option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.enabled_saved_payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.enabled_saved_payment_method","typeLabel":"boolean | null"},"hide_card_nickname_field":{"oneOf":[{"type":"boolean","description":"Hide card nickname field option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.hide_card_nickname_field.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Hide card nickname field option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.hide_card_nickname_field.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.hide_card_nickname_field","typeLabel":"boolean | null"},"show_card_form_by_default":{"oneOf":[{"type":"boolean","description":"Show card form by default for payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.show_card_form_by_default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Show card form by default for payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.show_card_form_by_default.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.show_card_form_by_default","typeLabel":"boolean | null"},"transaction_details":{"oneOf":[{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for the transaction details","example":"Policy-Number","maxLength":255,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Value for the transaction details","example":"297472368473924","maxLength":255,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].value","typeLabel":"string"},"ui_configuration":{"oneOf":[{"type":"object","properties":{"position":{"oneOf":[{"type":"integer","format":"int32","description":"Position of the key-value pair in the UI","example":5,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Position of the key-value pair in the UI","example":5,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position","typeLabel":"integer\u003cint32> | null"},"is_key_bold":{"oneOf":[{"type":"boolean","description":"Whether the key should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the key should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold","typeLabel":"boolean | null"},"is_value_bold":{"oneOf":[{"type":"boolean","description":"Whether the value should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the value should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold","typeLabel":"boolean | null"}},"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration","typeLabel":"object | null"}},"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Dynamic details related to merchant to be rendered in payment link","uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for the transaction details","example":"Policy-Number","maxLength":255},"value":{"type":"string","description":"Value for the transaction details","example":"297472368473924","maxLength":255},"ui_configuration":{"oneOf":[{"type":"object","properties":{"position":{"oneOf":[{"type":"integer","format":"int32","description":"Position of the key-value pair in the UI","example":5},{"type":"null","format":"int32","description":"Position of the key-value pair in the UI","example":5}]},"is_key_bold":{"oneOf":[{"type":"boolean","description":"Whether the key should be bold","default":false,"example":true},{"type":"null","description":"Whether the key should be bold","default":false,"example":true}]},"is_value_bold":{"oneOf":[{"type":"boolean","description":"Whether the value should be bold","default":false,"example":true},{"type":"null","description":"Whether the value should be bold","default":false,"example":true}]}}},{"type":"null"}]}}},"description":"Dynamic details related to merchant to be rendered in payment link","uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.transaction_details","typeLabel":"object[] | null"},"background_image":{"oneOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"URL of the image","example":"https://birrpay.io/favicon.ico","isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.url","typeLabel":"string"},"position":{"oneOf":[{"type":"string","enum":["left","top left","top","top right","right","bottom right","bottom","bottom left","center"],"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.position.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.position","typeLabel":"enum\u003cstring> | null"},"size":{"oneOf":[{"type":"object","required":["Variants"],"properties":{"Variants":{"type":"string","enum":["cover","contain"],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.0.Variants","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.0","typeLabel":"object"},{"type":"object","required":["Percentage"],"properties":{"Percentage":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.1.Percentage","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.1","typeLabel":"object"},{"type":"object","required":["Pixels"],"properties":{"Pixels":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.2.Pixels","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.3","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size","typeLabel":"object · object · object · null"}},"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.background_image","typeLabel":"object | null"},"details_layout":{"oneOf":[{"type":"string","enum":["layout1","layout2"],"uniqueKey":"payment_link_config.oneOf.0.details_layout.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.details_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.details_layout","typeLabel":"enum\u003cstring> | null"},"payment_button_text":{"oneOf":[{"type":"string","description":"Text for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.payment_button_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.payment_button_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_button_text","typeLabel":"string | null"},"custom_message_for_card_terms":{"oneOf":[{"type":"string","description":"Text for customizing message for card terms","uniqueKey":"payment_link_config.oneOf.0.custom_message_for_card_terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text for customizing message for card terms","uniqueKey":"payment_link_config.oneOf.0.custom_message_for_card_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_card_terms","typeLabel":"string | null"},"custom_message_for_payment_method_types":{"oneOf":[{"type":"array","items":{"type":"object","description":"Custom T\u0026C messages for a specific payment method","required":["payment_method","payment_method_types"],"properties":{"payment_method":{"type":"string","description":"Indicates the type of payment method. Eg: 'card', 'wallet', etc.","enum":["card","card_redirect","pay_later","wallet","bank_redirect","bank_transfer","crypto","bank_debit","reward","real_time_payment","upi","voucher","gift_card","open_banking","mobile_payment","network_token"],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method","typeLabel":"enum\u003cstring>"},"payment_method_types":{"type":"array","items":{"type":"object","description":"Custom T\u0026C message for a specific payment method type","required":["payment_method_type","message"],"properties":{"payment_method_type":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eps","flexiti","fps","evoucher","giropay","givex","google_pay","go_pay","gcash","ideal","interac","indomaret","klarna","kakao_pay","local_bank_redirect","mandiri_va","knet","mb_way","mobile_pay","momo","momo_atm","multibanco","online_banking_thailand","online_banking_czech_republic","online_banking_finland","online_banking_fpx","online_banking_poland","online_banking_slovakia","oxxo","pago_efectivo","permata_bank_transfer","open_banking_uk","pay_bright","payjustnow","paypal","paze","pix","pay_safe_card","przelewy24","prompt_pay","pse","qris","red_compra","red_pagos","samsung_pay","sepa","sepa_bank_transfer","sepa_guarenteed_debit","skrill","sofort","swish","touch_n_go","trustly","twint","upi_collect","upi_intent","upi_qr","vipps","viet_qr","venmo","walley","we_chat_pay","seven_eleven","lawson","mini_stop","family_mart","seicomart","pay_easy","local_bank_transfer","mifinity","open_banking_pis","direct_carrier_billing","instant_bank_transfer","instant_bank_transfer_finland","instant_bank_transfer_poland","revolut_pay","indonesian_bank_transfer","open_banking","network_token"],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].payment_method_type","typeLabel":"enum\u003cstring>"},"message":{"type":"object","description":"Custom T\u0026C message content and display mode","required":["value"],"properties":{"value":{"type":"string","description":"The text to be shown per payment method type","example":"I authorize Novalnet AG to debit my account.","isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message.value","typeLabel":"string"},"display_mode":{"type":"string","description":"Display mode options for controlling how messages are shown.","enum":["default_sdk_message","custom_message","hidden"],"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message.display_mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message","typeLabel":"object"}},"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX]","typeLabel":"object"},"description":"Payment Method Types","example":[{"message":{"display_mode":"custom","value":"Sample message"},"payment_method_type":"credit"}],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types","typeLabel":"object[]"}},"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"List of custom T\u0026C messages grouped by payment method","uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0","typeLabel":"object[]"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types","typeLabel":"object[] | null"},"payment_button_colour":{"oneOf":[{"type":"string","description":"Custom background colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.payment_button_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom background colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.payment_button_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_button_colour","typeLabel":"string | null"},"skip_status_screen":{"oneOf":[{"type":"boolean","description":"Skip the status screen after payment completion","uniqueKey":"payment_link_config.oneOf.0.skip_status_screen.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Skip the status screen after payment completion","uniqueKey":"payment_link_config.oneOf.0.skip_status_screen.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.skip_status_screen","typeLabel":"boolean | null"},"payment_button_text_colour":{"oneOf":[{"type":"string","description":"Custom text colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.payment_button_text_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom text colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.payment_button_text_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_button_text_colour","typeLabel":"string | null"},"background_colour":{"oneOf":[{"type":"string","description":"Custom background colour for the payment link","uniqueKey":"payment_link_config.oneOf.0.background_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom background colour for the payment link","uniqueKey":"payment_link_config.oneOf.0.background_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.background_colour","typeLabel":"string | null"},"sdk_ui_rules":{"oneOf":[{"type":"object","description":"SDK configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"SDK configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules.oneOf.1.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules","typeLabel":"object | null"},"payment_link_ui_rules":{"oneOf":[{"type":"object","description":"Payment link configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"Payment link configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules.oneOf.1.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules","typeLabel":"object | null"},"enable_button_only_on_form_ready":{"oneOf":[{"type":"boolean","description":"Flag to enable the button only when the payment form is ready for submission","uniqueKey":"payment_link_config.oneOf.0.enable_button_only_on_form_ready.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Flag to enable the button only when the payment form is ready for submission","uniqueKey":"payment_link_config.oneOf.0.enable_button_only_on_form_ready.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.enable_button_only_on_form_ready","typeLabel":"boolean | null"},"payment_form_header_text":{"oneOf":[{"type":"string","description":"Optional header for the SDK's payment form","uniqueKey":"payment_link_config.oneOf.0.payment_form_header_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional header for the SDK's payment form","uniqueKey":"payment_link_config.oneOf.0.payment_form_header_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_form_header_text","typeLabel":"string | null"},"payment_form_label_type":{"oneOf":[{"type":"string","enum":["above","floating","never"],"uniqueKey":"payment_link_config.oneOf.0.payment_form_label_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.payment_form_label_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_form_label_type","typeLabel":"enum\u003cstring> | null"},"show_card_terms":{"oneOf":[{"type":"string","enum":["always","auto","never"],"uniqueKey":"payment_link_config.oneOf.0.show_card_terms.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.show_card_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.show_card_terms","typeLabel":"enum\u003cstring> | null"},"is_setup_mandate_flow":{"oneOf":[{"type":"boolean","description":"Boolean to control payment button text for setup mandate calls","uniqueKey":"payment_link_config.oneOf.0.is_setup_mandate_flow.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Boolean to control payment button text for setup mandate calls","uniqueKey":"payment_link_config.oneOf.0.is_setup_mandate_flow.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.is_setup_mandate_flow","typeLabel":"boolean | null"},"color_icon_card_cvc_error":{"oneOf":[{"type":"string","description":"Hex color for the CVC icon during error state","uniqueKey":"payment_link_config.oneOf.0.color_icon_card_cvc_error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Hex color for the CVC icon during error state","uniqueKey":"payment_link_config.oneOf.0.color_icon_card_cvc_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.color_icon_card_cvc_error","typeLabel":"string | null"},"domain_name":{"oneOf":[{"type":"string","description":"Custom domain name to be used for hosting the link in your own domain","uniqueKey":"payment_link_config.oneOf.0.domain_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom domain name to be used for hosting the link in your own domain","uniqueKey":"payment_link_config.oneOf.0.domain_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.domain_name","typeLabel":"string | null"},"business_specific_configs":{"oneOf":[{"type":"object","description":"list of configs for multi theme setup","additionalProperties":{"type":"object","properties":{"theme":{"oneOf":[{"type":"string","description":"custom theme for the payment link","example":"#4E6ADD","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.theme.oneOf.0","typeLabel":"string"},{"type":"null","description":"custom theme for the payment link","example":"#4E6ADD","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.theme","typeLabel":"string | null"},"logo":{"oneOf":[{"type":"string","description":"merchant display logo","example":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"merchant display logo","example":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.logo","typeLabel":"string | null"},"seller_name":{"oneOf":[{"type":"string","description":"Custom merchant name for payment link","example":"hyperswitch","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.seller_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom merchant name for payment link","example":"hyperswitch","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.seller_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.seller_name","typeLabel":"string | null"},"sdk_layout":{"oneOf":[{"type":"string","description":"Custom layout for sdk","example":"accordion","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_layout.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom layout for sdk","example":"accordion","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_layout","typeLabel":"string | null"},"display_sdk_only":{"oneOf":[{"type":"boolean","description":"Display only the sdk for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.display_sdk_only.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Display only the sdk for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.display_sdk_only.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.display_sdk_only","typeLabel":"boolean | null"},"enabled_saved_payment_method":{"oneOf":[{"type":"boolean","description":"Enable saved payment method option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.enabled_saved_payment_method.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable saved payment method option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.enabled_saved_payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.enabled_saved_payment_method","typeLabel":"boolean | null"},"hide_card_nickname_field":{"oneOf":[{"type":"boolean","description":"Hide card nickname field option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.hide_card_nickname_field.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Hide card nickname field option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.hide_card_nickname_field.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.hide_card_nickname_field","typeLabel":"boolean | null"},"show_card_form_by_default":{"oneOf":[{"type":"boolean","description":"Show card form by default for payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.show_card_form_by_default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Show card form by default for payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.show_card_form_by_default.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.show_card_form_by_default","typeLabel":"boolean | null"},"transaction_details":{"oneOf":[{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for the transaction details","example":"Policy-Number","maxLength":255,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Value for the transaction details","example":"297472368473924","maxLength":255,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].value","typeLabel":"string"},"ui_configuration":{"oneOf":[{"type":"object","properties":{"position":{"oneOf":[{"type":"integer","format":"int32","description":"Position of the key-value pair in the UI","example":5,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Position of the key-value pair in the UI","example":5,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position","typeLabel":"integer\u003cint32> | null"},"is_key_bold":{"oneOf":[{"type":"boolean","description":"Whether the key should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the key should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold","typeLabel":"boolean | null"},"is_value_bold":{"oneOf":[{"type":"boolean","description":"Whether the value should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the value should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold","typeLabel":"boolean | null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration","typeLabel":"object | null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Dynamic details related to merchant to be rendered in payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for the transaction details","example":"Policy-Number","maxLength":255},"value":{"type":"string","description":"Value for the transaction details","example":"297472368473924","maxLength":255},"ui_configuration":{"oneOf":[{"type":"object","properties":{"position":{"oneOf":[{"type":"integer","format":"int32","description":"Position of the key-value pair in the UI","example":5},{"type":"null","format":"int32","description":"Position of the key-value pair in the UI","example":5}]},"is_key_bold":{"oneOf":[{"type":"boolean","description":"Whether the key should be bold","default":false,"example":true},{"type":"null","description":"Whether the key should be bold","default":false,"example":true}]},"is_value_bold":{"oneOf":[{"type":"boolean","description":"Whether the value should be bold","default":false,"example":true},{"type":"null","description":"Whether the value should be bold","default":false,"example":true}]}}},{"type":"null"}]}}},"description":"Dynamic details related to merchant to be rendered in payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details","typeLabel":"object[] | null"},"background_image":{"oneOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"URL of the image","example":"https://birrpay.io/favicon.ico","isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.url","typeLabel":"string"},"position":{"oneOf":[{"type":"string","enum":["left","top left","top","top right","right","bottom right","bottom","bottom left","center"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.position.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.position","typeLabel":"enum\u003cstring> | null"},"size":{"oneOf":[{"type":"object","required":["Variants"],"properties":{"Variants":{"type":"string","enum":["cover","contain"],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.0.Variants","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.0","typeLabel":"object"},{"type":"object","required":["Percentage"],"properties":{"Percentage":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.1.Percentage","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.1","typeLabel":"object"},{"type":"object","required":["Pixels"],"properties":{"Pixels":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.2.Pixels","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.3","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size","typeLabel":"object · object · object · null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image","typeLabel":"object | null"},"details_layout":{"oneOf":[{"type":"string","enum":["layout1","layout2"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.details_layout.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.details_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.details_layout","typeLabel":"enum\u003cstring> | null"},"payment_button_text":{"oneOf":[{"type":"string","description":"Text for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_text","typeLabel":"string | null"},"custom_message_for_card_terms":{"oneOf":[{"type":"string","description":"Text for customizing message for card terms","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_card_terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text for customizing message for card terms","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_card_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_card_terms","typeLabel":"string | null"},"custom_message_for_payment_method_types":{"oneOf":[{"type":"array","items":{"type":"object","description":"Custom T\u0026C messages for a specific payment method","required":["payment_method","payment_method_types"],"properties":{"payment_method":{"type":"string","description":"Indicates the type of payment method. Eg: 'card', 'wallet', etc.","enum":["card","card_redirect","pay_later","wallet","bank_redirect","bank_transfer","crypto","bank_debit","reward","real_time_payment","upi","voucher","gift_card","open_banking","mobile_payment","network_token"],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method","typeLabel":"enum\u003cstring>"},"payment_method_types":{"type":"array","items":{"type":"object","description":"Custom T\u0026C message for a specific payment method type","required":["payment_method_type","message"],"properties":{"payment_method_type":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eps","flexiti","fps","evoucher","giropay","givex","google_pay","go_pay","gcash","ideal","interac","indomaret","klarna","kakao_pay","local_bank_redirect","mandiri_va","knet","mb_way","mobile_pay","momo","momo_atm","multibanco","online_banking_thailand","online_banking_czech_republic","online_banking_finland","online_banking_fpx","online_banking_poland","online_banking_slovakia","oxxo","pago_efectivo","permata_bank_transfer","open_banking_uk","pay_bright","payjustnow","paypal","paze","pix","pay_safe_card","przelewy24","prompt_pay","pse","qris","red_compra","red_pagos","samsung_pay","sepa","sepa_bank_transfer","sepa_guarenteed_debit","skrill","sofort","swish","touch_n_go","trustly","twint","upi_collect","upi_intent","upi_qr","vipps","viet_qr","venmo","walley","we_chat_pay","seven_eleven","lawson","mini_stop","family_mart","seicomart","pay_easy","local_bank_transfer","mifinity","open_banking_pis","direct_carrier_billing","instant_bank_transfer","instant_bank_transfer_finland","instant_bank_transfer_poland","revolut_pay","indonesian_bank_transfer","open_banking","network_token"],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].payment_method_type","typeLabel":"enum\u003cstring>"},"message":{"type":"object","description":"Custom T\u0026C message content and display mode","required":["value"],"properties":{"value":{"type":"string","description":"The text to be shown per payment method type","example":"I authorize Novalnet AG to debit my account.","isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message.value","typeLabel":"string"},"display_mode":{"type":"string","description":"Display mode options for controlling how messages are shown.","enum":["default_sdk_message","custom_message","hidden"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message.display_mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message","typeLabel":"object"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX]","typeLabel":"object"},"description":"Payment Method Types","example":[{"message":{"display_mode":"custom","value":"Sample message"},"payment_method_type":"credit"}],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types","typeLabel":"object[]"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"List of custom T\u0026C messages grouped by payment method","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0","typeLabel":"object[]"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types","typeLabel":"object[] | null"},"payment_button_colour":{"oneOf":[{"type":"string","description":"Custom background colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom background colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_colour","typeLabel":"string | null"},"skip_status_screen":{"oneOf":[{"type":"boolean","description":"Skip the status screen after payment completion","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.skip_status_screen.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Skip the status screen after payment completion","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.skip_status_screen.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.skip_status_screen","typeLabel":"boolean | null"},"payment_button_text_colour":{"oneOf":[{"type":"string","description":"Custom text colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_text_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom text colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_text_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_text_colour","typeLabel":"string | null"},"background_colour":{"oneOf":[{"type":"string","description":"Custom background colour for the payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom background colour for the payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_colour","typeLabel":"string | null"},"sdk_ui_rules":{"oneOf":[{"type":"object","description":"SDK configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"SDK configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules.oneOf.1.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules","typeLabel":"object | null"},"payment_link_ui_rules":{"oneOf":[{"type":"object","description":"Payment link configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"Payment link configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules.oneOf.1.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules","typeLabel":"object | null"},"enable_button_only_on_form_ready":{"oneOf":[{"type":"boolean","description":"Flag to enable the button only when the payment form is ready for submission","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.enable_button_only_on_form_ready.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Flag to enable the button only when the payment form is ready for submission","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.enable_button_only_on_form_ready.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.enable_button_only_on_form_ready","typeLabel":"boolean | null"},"payment_form_header_text":{"oneOf":[{"type":"string","description":"Optional header for the SDK's payment form","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_form_header_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional header for the SDK's payment form","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_form_header_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_form_header_text","typeLabel":"string | null"},"payment_form_label_type":{"oneOf":[{"type":"string","enum":["above","floating","never"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_form_label_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_form_label_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_form_label_type","typeLabel":"enum\u003cstring> | null"},"show_card_terms":{"oneOf":[{"type":"string","enum":["always","auto","never"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.show_card_terms.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.show_card_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.show_card_terms","typeLabel":"enum\u003cstring> | null"},"is_setup_mandate_flow":{"oneOf":[{"type":"boolean","description":"Boolean to control payment button text for setup mandate calls","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.is_setup_mandate_flow.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Boolean to control payment button text for setup mandate calls","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.is_setup_mandate_flow.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.is_setup_mandate_flow","typeLabel":"boolean | null"},"color_icon_card_cvc_error":{"oneOf":[{"type":"string","description":"Hex color for the CVC icon during error state","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.color_icon_card_cvc_error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Hex color for the CVC icon during error state","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.color_icon_card_cvc_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.color_icon_card_cvc_error","typeLabel":"string | null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0","typeLabel":"object"},{"type":"null","description":"list of configs for multi theme setup","additionalProperties":{"type":"object","properties":{"theme":{"oneOf":[{"type":"string","description":"custom theme for the payment link","example":"#4E6ADD","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.theme.oneOf.0","typeLabel":"string"},{"type":"null","description":"custom theme for the payment link","example":"#4E6ADD","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.theme","typeLabel":"string | null"},"logo":{"oneOf":[{"type":"string","description":"merchant display logo","example":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"merchant display logo","example":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.logo","typeLabel":"string | null"},"seller_name":{"oneOf":[{"type":"string","description":"Custom merchant name for payment link","example":"hyperswitch","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.seller_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom merchant name for payment link","example":"hyperswitch","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.seller_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.seller_name","typeLabel":"string | null"},"sdk_layout":{"oneOf":[{"type":"string","description":"Custom layout for sdk","example":"accordion","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_layout.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom layout for sdk","example":"accordion","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_layout","typeLabel":"string | null"},"display_sdk_only":{"oneOf":[{"type":"boolean","description":"Display only the sdk for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.display_sdk_only.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Display only the sdk for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.display_sdk_only.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.display_sdk_only","typeLabel":"boolean | null"},"enabled_saved_payment_method":{"oneOf":[{"type":"boolean","description":"Enable saved payment method option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.enabled_saved_payment_method.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable saved payment method option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.enabled_saved_payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.enabled_saved_payment_method","typeLabel":"boolean | null"},"hide_card_nickname_field":{"oneOf":[{"type":"boolean","description":"Hide card nickname field option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.hide_card_nickname_field.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Hide card nickname field option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.hide_card_nickname_field.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.hide_card_nickname_field","typeLabel":"boolean | null"},"show_card_form_by_default":{"oneOf":[{"type":"boolean","description":"Show card form by default for payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.show_card_form_by_default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Show card form by default for payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.show_card_form_by_default.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.show_card_form_by_default","typeLabel":"boolean | null"},"transaction_details":{"oneOf":[{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for the transaction details","example":"Policy-Number","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Value for the transaction details","example":"297472368473924","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].value","typeLabel":"string"},"ui_configuration":{"oneOf":[{"type":"object","properties":{"position":{"oneOf":[{"type":"integer","format":"int32","description":"Position of the key-value pair in the UI","example":5,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Position of the key-value pair in the UI","example":5,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position","typeLabel":"integer\u003cint32> | null"},"is_key_bold":{"oneOf":[{"type":"boolean","description":"Whether the key should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the key should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold","typeLabel":"boolean | null"},"is_value_bold":{"oneOf":[{"type":"boolean","description":"Whether the value should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the value should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold","typeLabel":"boolean | null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration","typeLabel":"object | null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Dynamic details related to merchant to be rendered in payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for the transaction details","example":"Policy-Number","maxLength":255},"value":{"type":"string","description":"Value for the transaction details","example":"297472368473924","maxLength":255},"ui_configuration":{"oneOf":[{"type":"object","properties":{"position":{"oneOf":[{"type":"integer","format":"int32","description":"Position of the key-value pair in the UI","example":5},{"type":"null","format":"int32","description":"Position of the key-value pair in the UI","example":5}]},"is_key_bold":{"oneOf":[{"type":"boolean","description":"Whether the key should be bold","default":false,"example":true},{"type":"null","description":"Whether the key should be bold","default":false,"example":true}]},"is_value_bold":{"oneOf":[{"type":"boolean","description":"Whether the value should be bold","default":false,"example":true},{"type":"null","description":"Whether the value should be bold","default":false,"example":true}]}}},{"type":"null"}]}}},"description":"Dynamic details related to merchant to be rendered in payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details","typeLabel":"object[] | null"},"background_image":{"oneOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"URL of the image","example":"https://birrpay.io/favicon.ico","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.url","typeLabel":"string"},"position":{"oneOf":[{"type":"string","enum":["left","top left","top","top right","right","bottom right","bottom","bottom left","center"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.position.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.position","typeLabel":"enum\u003cstring> | null"},"size":{"oneOf":[{"type":"object","required":["Variants"],"properties":{"Variants":{"type":"string","enum":["cover","contain"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.0.Variants","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.0","typeLabel":"object"},{"type":"object","required":["Percentage"],"properties":{"Percentage":{"type":"integer","format":"int32","minimum":0,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.1.Percentage","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.1","typeLabel":"object"},{"type":"object","required":["Pixels"],"properties":{"Pixels":{"type":"integer","format":"int32","minimum":0,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.2.Pixels","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.3","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size","typeLabel":"object · object · object · null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image","typeLabel":"object | null"},"details_layout":{"oneOf":[{"type":"string","enum":["layout1","layout2"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.details_layout.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.details_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.details_layout","typeLabel":"enum\u003cstring> | null"},"payment_button_text":{"oneOf":[{"type":"string","description":"Text for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_text","typeLabel":"string | null"},"custom_message_for_card_terms":{"oneOf":[{"type":"string","description":"Text for customizing message for card terms","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_card_terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text for customizing message for card terms","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_card_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_card_terms","typeLabel":"string | null"},"custom_message_for_payment_method_types":{"oneOf":[{"type":"array","items":{"type":"object","description":"Custom T\u0026C messages for a specific payment method","required":["payment_method","payment_method_types"],"properties":{"payment_method":{"type":"string","description":"Indicates the type of payment method. Eg: 'card', 'wallet', etc.","enum":["card","card_redirect","pay_later","wallet","bank_redirect","bank_transfer","crypto","bank_debit","reward","real_time_payment","upi","voucher","gift_card","open_banking","mobile_payment","network_token"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method","typeLabel":"enum\u003cstring>"},"payment_method_types":{"type":"array","items":{"type":"object","description":"Custom T\u0026C message for a specific payment method type","required":["payment_method_type","message"],"properties":{"payment_method_type":{"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":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].payment_method_type","typeLabel":"enum\u003cstring>"},"message":{"type":"object","description":"Custom T\u0026C message content and display mode","required":["value"],"properties":{"value":{"type":"string","description":"The text to be shown per payment method type","example":"I authorize Novalnet AG to debit my account.","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message.value","typeLabel":"string"},"display_mode":{"type":"string","description":"Display mode options for controlling how messages are shown.","enum":["default_sdk_message","custom_message","hidden"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message.display_mode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message","typeLabel":"object"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX]","typeLabel":"object"},"description":"Payment Method Types","example":[{"message":{"display_mode":"custom","value":"Sample message"},"payment_method_type":"credit"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types","typeLabel":"object[]"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"List of custom T\u0026C messages grouped by payment method","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0","typeLabel":"object[]"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types","typeLabel":"object[] | null"},"payment_button_colour":{"oneOf":[{"type":"string","description":"Custom background colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom background colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_colour","typeLabel":"string | null"},"skip_status_screen":{"oneOf":[{"type":"boolean","description":"Skip the status screen after payment completion","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.skip_status_screen.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Skip the status screen after payment completion","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.skip_status_screen.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.skip_status_screen","typeLabel":"boolean | null"},"payment_button_text_colour":{"oneOf":[{"type":"string","description":"Custom text colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_text_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom text colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_text_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_text_colour","typeLabel":"string | null"},"background_colour":{"oneOf":[{"type":"string","description":"Custom background colour for the payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom background colour for the payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_colour","typeLabel":"string | null"},"sdk_ui_rules":{"oneOf":[{"type":"object","description":"SDK configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"SDK configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules.oneOf.1.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules","typeLabel":"object | null"},"payment_link_ui_rules":{"oneOf":[{"type":"object","description":"Payment link configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"Payment link configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules.oneOf.1.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules","typeLabel":"object | null"},"enable_button_only_on_form_ready":{"oneOf":[{"type":"boolean","description":"Flag to enable the button only when the payment form is ready for submission","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.enable_button_only_on_form_ready.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Flag to enable the button only when the payment form is ready for submission","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.enable_button_only_on_form_ready.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.enable_button_only_on_form_ready","typeLabel":"boolean | null"},"payment_form_header_text":{"oneOf":[{"type":"string","description":"Optional header for the SDK's payment form","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_form_header_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional header for the SDK's payment form","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_form_header_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_form_header_text","typeLabel":"string | null"},"payment_form_label_type":{"oneOf":[{"type":"string","enum":["above","floating","never"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_form_label_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_form_label_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_form_label_type","typeLabel":"enum\u003cstring> | null"},"show_card_terms":{"oneOf":[{"type":"string","enum":["always","auto","never"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.show_card_terms.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.show_card_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.show_card_terms","typeLabel":"enum\u003cstring> | null"},"is_setup_mandate_flow":{"oneOf":[{"type":"boolean","description":"Boolean to control payment button text for setup mandate calls","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.is_setup_mandate_flow.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Boolean to control payment button text for setup mandate calls","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.is_setup_mandate_flow.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.is_setup_mandate_flow","typeLabel":"boolean | null"},"color_icon_card_cvc_error":{"oneOf":[{"type":"string","description":"Hex color for the CVC icon during error state","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.color_icon_card_cvc_error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Hex color for the CVC icon during error state","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.color_icon_card_cvc_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.color_icon_card_cvc_error","typeLabel":"string | null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs","typeLabel":"object | null"},"allowed_domains":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.allowed_domains.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"A list of allowed domains (glob patterns) where this link can be embedded / opened from","uniqueItems":true,"uniqueKey":"payment_link_config.oneOf.0.allowed_domains.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"A list of allowed domains (glob patterns) where this link can be embedded / opened from","uniqueItems":true,"uniqueKey":"payment_link_config.oneOf.0.allowed_domains.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.allowed_domains","typeLabel":"string[] | null"},"branding_visibility":{"oneOf":[{"type":"boolean","description":"Toggle for HyperSwitch branding visibility","uniqueKey":"payment_link_config.oneOf.0.branding_visibility.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Toggle for HyperSwitch branding visibility","uniqueKey":"payment_link_config.oneOf.0.branding_visibility.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.branding_visibility","typeLabel":"boolean | null"}},"uniqueKey":"payment_link_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config","typeLabel":"object | null"},"authentication_connector_details":{"oneOf":[{"type":"object","required":["authentication_connectors","three_ds_requestor_url"],"properties":{"authentication_connectors":{"type":"array","items":{"type":"string","enum":["threedsecureio","netcetera","gpayments","ctp_mastercard","unified_authentication_service","juspaythreedsserver","ctp_visa","cardinal"],"uniqueKey":"authentication_connector_details.oneOf.0.authentication_connectors.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"List of authentication connectors","isRequired":true,"uniqueKey":"authentication_connector_details.oneOf.0.authentication_connectors","typeLabel":"enum\u003cstring>[]"},"three_ds_requestor_url":{"type":"string","description":"URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.","isRequired":true,"uniqueKey":"authentication_connector_details.oneOf.0.three_ds_requestor_url","typeLabel":"string"},"three_ds_requestor_app_url":{"oneOf":[{"type":"string","description":"Merchant app declaring their URL within the CReq message so that the Authentication app can call the Merchant app after OOB authentication has occurred.","uniqueKey":"authentication_connector_details.oneOf.0.three_ds_requestor_app_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant app declaring their URL within the CReq message so that the Authentication app can call the Merchant app after OOB authentication has occurred.","uniqueKey":"authentication_connector_details.oneOf.0.three_ds_requestor_app_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_connector_details.oneOf.0.three_ds_requestor_app_url","typeLabel":"string | null"}},"uniqueKey":"authentication_connector_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"authentication_connector_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_connector_details","typeLabel":"object | null"},"use_billing_as_payment_method_billing":{"oneOf":[{"type":"boolean","description":"Whether to use the billing details passed when creating the intent as payment method billing","uniqueKey":"use_billing_as_payment_method_billing.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether to use the billing details passed when creating the intent as payment method billing","uniqueKey":"use_billing_as_payment_method_billing.oneOf.1","typeLabel":"null"}],"uniqueKey":"use_billing_as_payment_method_billing","typeLabel":"boolean | null"},"collect_shipping_details_from_wallet_connector_if_required":{"oneOf":[{"type":"boolean","description":"A boolean value to indicate if customer shipping details needs to be collected from wallet\nconnector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)","default":false,"example":false,"uniqueKey":"collect_shipping_details_from_wallet_connector_if_required.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"A boolean value to indicate if customer shipping details needs to be collected from wallet\nconnector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)","default":false,"example":false,"uniqueKey":"collect_shipping_details_from_wallet_connector_if_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"collect_shipping_details_from_wallet_connector_if_required","typeLabel":"boolean | null"},"collect_billing_details_from_wallet_connector_if_required":{"oneOf":[{"type":"boolean","description":"A boolean value to indicate if customer billing details needs to be collected from wallet\nconnector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)","default":false,"example":false,"uniqueKey":"collect_billing_details_from_wallet_connector_if_required.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"A boolean value to indicate if customer billing details needs to be collected from wallet\nconnector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)","default":false,"example":false,"uniqueKey":"collect_billing_details_from_wallet_connector_if_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"collect_billing_details_from_wallet_connector_if_required","typeLabel":"boolean | null"},"always_collect_shipping_details_from_wallet_connector":{"oneOf":[{"type":"boolean","description":"A boolean value to indicate if customer shipping details needs to be collected from wallet\nconnector irrespective of connector required fields (Eg. Apple pay, Google pay etc)","default":false,"example":false,"uniqueKey":"always_collect_shipping_details_from_wallet_connector.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"A boolean value to indicate if customer shipping details needs to be collected from wallet\nconnector irrespective of connector required fields (Eg. Apple pay, Google pay etc)","default":false,"example":false,"uniqueKey":"always_collect_shipping_details_from_wallet_connector.oneOf.1","typeLabel":"null"}],"uniqueKey":"always_collect_shipping_details_from_wallet_connector","typeLabel":"boolean | null"},"always_collect_billing_details_from_wallet_connector":{"oneOf":[{"type":"boolean","description":"A boolean value to indicate if customer billing details needs to be collected from wallet\nconnector irrespective of connector required fields (Eg. Apple pay, Google pay etc)","default":false,"example":false,"uniqueKey":"always_collect_billing_details_from_wallet_connector.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"A boolean value to indicate if customer billing details needs to be collected from wallet\nconnector irrespective of connector required fields (Eg. Apple pay, Google pay etc)","default":false,"example":false,"uniqueKey":"always_collect_billing_details_from_wallet_connector.oneOf.1","typeLabel":"null"}],"uniqueKey":"always_collect_billing_details_from_wallet_connector","typeLabel":"boolean | null"},"is_connector_agnostic_mit_enabled":{"oneOf":[{"type":"boolean","description":"Indicates if the MIT (merchant initiated transaction) payments can be made connector\nagnostic, i.e., MITs may be processed through different connector than CIT (customer\ninitiated transaction) based on the routing rules.\nIf set to `false`, MIT will go through the same connector as the CIT.","uniqueKey":"is_connector_agnostic_mit_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if the MIT (merchant initiated transaction) payments can be made connector\nagnostic, i.e., MITs may be processed through different connector than CIT (customer\ninitiated transaction) based on the routing rules.\nIf set to `false`, MIT will go through the same connector as the CIT.","uniqueKey":"is_connector_agnostic_mit_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_connector_agnostic_mit_enabled","typeLabel":"boolean | null"},"payout_link_config":{"oneOf":[{"type":"object","description":"Object for GenericLinkUiConfig","required":["allowed_domains"],"properties":{"allowed_domains":{"type":"array","items":{"type":"string","uniqueKey":"payout_link_config.oneOf.0.allowed_domains.items.[INDEX]","typeLabel":"string"},"description":"A list of allowed domains (glob patterns) where this link can be embedded / opened from","uniqueItems":true,"isRequired":true,"uniqueKey":"payout_link_config.oneOf.0.allowed_domains","typeLabel":"string[]"},"logo":{"oneOf":[{"type":"string","description":"Merchant's display logo","example":"https://birrpay.io/favicon.ico","maxLength":255,"uniqueKey":"payout_link_config.oneOf.0.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant's display logo","example":"https://birrpay.io/favicon.ico","maxLength":255,"uniqueKey":"payout_link_config.oneOf.0.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config.oneOf.0.logo","typeLabel":"string | null"},"merchant_name":{"oneOf":[{"type":"string","description":"Custom merchant name for the link","example":"BirrPay","maxLength":255,"uniqueKey":"payout_link_config.oneOf.0.merchant_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom merchant name for the link","example":"BirrPay","maxLength":255,"uniqueKey":"payout_link_config.oneOf.0.merchant_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config.oneOf.0.merchant_name","typeLabel":"string | null"},"theme":{"oneOf":[{"type":"string","description":"Primary color to be used in the form represented in hex format","example":"#4285F4","maxLength":255,"uniqueKey":"payout_link_config.oneOf.0.theme.oneOf.0","typeLabel":"string"},{"type":"null","description":"Primary color to be used in the form represented in hex format","example":"#4285F4","maxLength":255,"uniqueKey":"payout_link_config.oneOf.0.theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config.oneOf.0.theme","typeLabel":"string | null"},"domain_name":{"oneOf":[{"type":"string","description":"Custom domain name to be used for hosting the link","uniqueKey":"payout_link_config.oneOf.0.domain_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom domain name to be used for hosting the link","uniqueKey":"payout_link_config.oneOf.0.domain_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config.oneOf.0.domain_name","typeLabel":"string | null"},"form_layout":{"oneOf":[{"type":"string","enum":["tabs","journey"],"uniqueKey":"payout_link_config.oneOf.0.form_layout.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payout_link_config.oneOf.0.form_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config.oneOf.0.form_layout","typeLabel":"enum\u003cstring> | null"},"payout_test_mode":{"oneOf":[{"type":"boolean","description":"Allows for removing any validations / pre-requisites which are necessary in a production environment","default":false,"uniqueKey":"payout_link_config.oneOf.0.payout_test_mode.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Allows for removing any validations / pre-requisites which are necessary in a production environment","default":false,"uniqueKey":"payout_link_config.oneOf.0.payout_test_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config.oneOf.0.payout_test_mode","typeLabel":"boolean | null"}},"uniqueKey":"payout_link_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payout_link_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config","typeLabel":"object | null"},"outgoing_webhook_custom_http_headers":{"oneOf":[{"type":"object","description":"These key-value pairs are sent as additional custom headers in the outgoing webhook request. It is recommended not to use more than four key-value pairs.","uniqueKey":"outgoing_webhook_custom_http_headers.oneOf.0","typeLabel":"object"},{"type":"null","description":"These key-value pairs are sent as additional custom headers in the outgoing webhook request. It is recommended not to use more than four key-value pairs.","uniqueKey":"outgoing_webhook_custom_http_headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"outgoing_webhook_custom_http_headers","typeLabel":"object | null"},"tax_connector_id":{"oneOf":[{"type":"string","description":"Merchant Connector id to be stored for tax_calculator connector","uniqueKey":"tax_connector_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant Connector id to be stored for tax_calculator connector","uniqueKey":"tax_connector_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax_connector_id","typeLabel":"string | null"},"is_tax_connector_enabled":{"type":"boolean","description":"Indicates if tax_calculator connector is enabled or not.\nIf set to `true` tax_connector_id will be checked.","uniqueKey":"is_tax_connector_enabled","typeLabel":"boolean"},"is_network_tokenization_enabled":{"type":"boolean","description":"Indicates if network tokenization is enabled or not.","uniqueKey":"is_network_tokenization_enabled","typeLabel":"boolean"},"is_click_to_pay_enabled":{"type":"boolean","description":"Indicates if click to pay is enabled or not.","default":false,"example":false,"uniqueKey":"is_click_to_pay_enabled","typeLabel":"boolean"},"authentication_product_ids":{"oneOf":[{"type":"object","description":"Product authentication ids","uniqueKey":"authentication_product_ids.oneOf.0","typeLabel":"object"},{"type":"null","description":"Product authentication ids","uniqueKey":"authentication_product_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_product_ids","typeLabel":"object | null"},"card_testing_guard_config":{"oneOf":[{"type":"object","required":["card_ip_blocking_status","card_ip_blocking_threshold","guest_user_card_blocking_status","guest_user_card_blocking_threshold","customer_id_blocking_status","customer_id_blocking_threshold","card_testing_guard_expiry"],"properties":{"card_ip_blocking_status":{"type":"string","enum":["enabled","disabled"],"isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.card_ip_blocking_status","typeLabel":"enum\u003cstring>"},"card_ip_blocking_threshold":{"type":"integer","format":"int32","description":"Determines the unsuccessful payment threshold for Card IP Blocking for profile","isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.card_ip_blocking_threshold","typeLabel":"integer\u003cint32>"},"guest_user_card_blocking_status":{"type":"string","enum":["enabled","disabled"],"isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.guest_user_card_blocking_status","typeLabel":"enum\u003cstring>"},"guest_user_card_blocking_threshold":{"type":"integer","format":"int32","description":"Determines the unsuccessful payment threshold for Guest User Card Blocking for profile","isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.guest_user_card_blocking_threshold","typeLabel":"integer\u003cint32>"},"customer_id_blocking_status":{"type":"string","enum":["enabled","disabled"],"isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.customer_id_blocking_status","typeLabel":"enum\u003cstring>"},"customer_id_blocking_threshold":{"type":"integer","format":"int32","description":"Determines the unsuccessful payment threshold for Customer Id Blocking for profile","isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.customer_id_blocking_threshold","typeLabel":"integer\u003cint32>"},"card_testing_guard_expiry":{"type":"integer","format":"int32","description":"Determines Redis Expiry for Card Testing Guard for profile","isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.card_testing_guard_expiry","typeLabel":"integer\u003cint32>"}},"uniqueKey":"card_testing_guard_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"card_testing_guard_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"card_testing_guard_config","typeLabel":"object | null"},"is_clear_pan_retries_enabled":{"oneOf":[{"type":"boolean","description":"Indicates if clear pan retries is enabled or not.","uniqueKey":"is_clear_pan_retries_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if clear pan retries is enabled or not.","uniqueKey":"is_clear_pan_retries_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_clear_pan_retries_enabled","typeLabel":"boolean | null"},"is_debit_routing_enabled":{"oneOf":[{"type":"boolean","description":"Indicates if debit routing is enabled or not","uniqueKey":"is_debit_routing_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if debit routing is enabled or not","uniqueKey":"is_debit_routing_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_debit_routing_enabled","typeLabel":"boolean | null"},"merchant_business_country":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"merchant_business_country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"merchant_business_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_business_country","typeLabel":"enum\u003cstring> | null"},"is_iframe_redirection_enabled":{"oneOf":[{"type":"boolean","description":"Indicates if the redirection has to open in the iframe","example":false,"uniqueKey":"is_iframe_redirection_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if the redirection has to open in the iframe","example":false,"uniqueKey":"is_iframe_redirection_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_iframe_redirection_enabled","typeLabel":"boolean | null"},"is_external_vault_enabled":{"oneOf":[{"type":"boolean","description":"Indicates if external vault is enabled or not.","uniqueKey":"is_external_vault_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if external vault is enabled or not.","uniqueKey":"is_external_vault_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_external_vault_enabled","typeLabel":"boolean | null"},"external_vault_connector_details":{"oneOf":[{"type":"object","properties":{"vault_connector_id":{"oneOf":[{"type":"string","description":"Merchant Connector id to be stored for vault connector","uniqueKey":"external_vault_connector_details.oneOf.0.vault_connector_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant Connector id to be stored for vault connector","uniqueKey":"external_vault_connector_details.oneOf.0.vault_connector_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_vault_connector_details.oneOf.0.vault_connector_id","typeLabel":"string | null"},"vault_sdk":{"oneOf":[{"type":"string","enum":["vgs_sdk","hyperswitch_sdk"],"uniqueKey":"external_vault_connector_details.oneOf.0.vault_sdk.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"external_vault_connector_details.oneOf.0.vault_sdk.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_vault_connector_details.oneOf.0.vault_sdk","typeLabel":"enum\u003cstring> | null"},"vault_token_selector":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"token_type":{"oneOf":[{"type":"string","description":"Fields that can be tokenized with vault","enum":["card_number","card_cvc","card_expiry_year","card_expiry_month","network_token","network_token_expiry_year","network_token_expiry_month","network_token_cryptogram"],"uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector.oneOf.0.items.[INDEX].token_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector.oneOf.0.items.[INDEX].token_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector.oneOf.0.items.[INDEX].token_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Fields to tokenization in vault","uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"token_type":{"oneOf":[{"type":"string","description":"Fields that can be tokenized with vault","enum":["card_number","card_cvc","card_expiry_year","card_expiry_month","network_token","network_token_expiry_year","network_token_expiry_month","network_token_cryptogram"]},{"type":"null"}]}}},"description":"Fields to tokenization in vault","uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector","typeLabel":"object[] | null"}},"uniqueKey":"external_vault_connector_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"external_vault_connector_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_vault_connector_details","typeLabel":"object | null"},"merchant_category_code":{"oneOf":[{"type":"string","title":"4 digit Merchant category code (MCC)","example":"5411","uniqueKey":"merchant_category_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"merchant_category_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_category_code","typeLabel":"string | null"},"merchant_country_code":{"oneOf":[{"type":"string","description":"A wrapper type for merchant country codes that provides validation and conversion functionality.\n\nThis type stores a country code as a string and provides methods to validate it\nand convert it to a `Country` enum variant.","uniqueKey":"merchant_country_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"merchant_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_country_code","typeLabel":"string | null"},"split_txns_enabled":{"oneOf":[{"type":"string","default":"skip","enum":["enable","skip"],"uniqueKey":"split_txns_enabled.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"split_txns_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"split_txns_enabled","typeLabel":"enum\u003cstring> | null"},"billing_processor_id":{"oneOf":[{"type":"string","description":"Merchant Connector id to be stored for billing_processor connector","uniqueKey":"billing_processor_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant Connector id to be stored for billing_processor connector","uniqueKey":"billing_processor_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_processor_id","typeLabel":"string | null"},"is_l2_l3_enabled":{"oneOf":[{"type":"boolean","description":"Flag to enable Level 2 and Level 3 processing data for card transactions","uniqueKey":"is_l2_l3_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Flag to enable Level 2 and Level 3 processing data for card transactions","uniqueKey":"is_l2_l3_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_l2_l3_enabled","typeLabel":"boolean | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Update profile with profile name fields":{"title":"Update profile with profile name fields","value":{"profile_name":"shoe_business"}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"7d7e70b2-682e-416c-a72e-a8973deb9efc":{"description":"Profile Updated","content":{"application/json":{"schema":{"type":"object","required":["merchant_id","id","profile_name","enable_payment_response_hash","redirect_to_merchant_with_http_post","is_tax_connector_enabled","is_network_tokenization_enabled","is_click_to_pay_enabled","is_clear_pan_retries_enabled","split_txns_enabled"],"properties":{"merchant_id":{"type":"string","description":"The identifier for Merchant Account","example":"y3oqhf46pyzuxjbcn2giaqnb44","maxLength":64,"isRequired":true,"uniqueKey":"merchant_id","typeLabel":"string"},"id":{"type":"string","description":"The identifier for profile. This must be used for creating merchant accounts, payments and payouts","example":"pro_abcdefghijklmnopqrstuvwxyz","maxLength":64,"isRequired":true,"uniqueKey":"id","typeLabel":"string"},"profile_name":{"type":"string","description":"Name of the profile","maxLength":64,"isRequired":true,"uniqueKey":"profile_name","typeLabel":"string"},"enable_payment_response_hash":{"type":"boolean","description":"A boolean value to indicate if payment response hash needs to be enabled","default":true,"example":true,"isRequired":true,"uniqueKey":"enable_payment_response_hash","typeLabel":"boolean"},"redirect_to_merchant_with_http_post":{"type":"boolean","description":"A boolean value to indicate if redirect to merchant with http post needs to be enabled","default":false,"example":true,"isRequired":true,"uniqueKey":"redirect_to_merchant_with_http_post","typeLabel":"boolean"},"is_tax_connector_enabled":{"type":"boolean","description":"Indicates if tax_calculator connector is enabled or not.\nIf set to `true` tax_connector_id will be checked.","isRequired":true,"uniqueKey":"is_tax_connector_enabled","typeLabel":"boolean"},"is_network_tokenization_enabled":{"type":"boolean","description":"Indicates if network tokenization is enabled or not.","default":false,"example":false,"isRequired":true,"uniqueKey":"is_network_tokenization_enabled","typeLabel":"boolean"},"is_click_to_pay_enabled":{"type":"boolean","description":"Indicates if click to pay is enabled or not.","default":false,"example":false,"isRequired":true,"uniqueKey":"is_click_to_pay_enabled","typeLabel":"boolean"},"is_clear_pan_retries_enabled":{"type":"boolean","description":"Indicates if clear pan retries is enabled or not.","isRequired":true,"uniqueKey":"is_clear_pan_retries_enabled","typeLabel":"boolean"},"split_txns_enabled":{"type":"string","default":"skip","enum":["enable","skip"],"isRequired":true,"uniqueKey":"split_txns_enabled","typeLabel":"enum\u003cstring>"},"return_url":{"oneOf":[{"type":"string","description":"The URL to redirect after the completion of the operation","example":"https://www.example.com/success","maxLength":255,"uniqueKey":"return_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to redirect after the completion of the operation","example":"https://www.example.com/success","maxLength":255,"uniqueKey":"return_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"return_url","typeLabel":"string | null"},"payment_response_hash_key":{"oneOf":[{"type":"string","description":"Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a value is automatically generated.","uniqueKey":"payment_response_hash_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Refers to the hash key used for calculating the signature for webhooks and redirect response. If the value is not provided, a value is automatically generated.","uniqueKey":"payment_response_hash_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_response_hash_key","typeLabel":"string | null"},"webhook_details":{"oneOf":[{"type":"object","required":["payment_statuses_enabled","refund_statuses_enabled"],"properties":{"payment_statuses_enabled":{"type":"array","items":{"type":"string","description":"Represents the overall status of a payment intent.\nThe status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).","enum":["succeeded","failed","cancelled","cancelled_post_capture","processing","requires_customer_action","requires_merchant_action","requires_payment_method","requires_confirmation","requires_capture","partially_captured","partially_captured_and_capturable","partially_authorized_and_requires_capture","partially_captured_and_processing","conflicted","expired"],"uniqueKey":"webhook_details.oneOf.0.payment_statuses_enabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"List of payment statuses that triggers a webhook for payment intents","example":["succeeded","failed","partially_captured","requires_merchant_action"],"isRequired":true,"uniqueKey":"webhook_details.oneOf.0.payment_statuses_enabled","typeLabel":"enum\u003cstring>[]"},"refund_statuses_enabled":{"type":"array","items":{"type":"string","description":"Represents the overall status of a payment intent.\nThe status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).","enum":["succeeded","failed","cancelled","cancelled_post_capture","processing","requires_customer_action","requires_merchant_action","requires_payment_method","requires_confirmation","requires_capture","partially_captured","partially_captured_and_capturable","partially_authorized_and_requires_capture","partially_captured_and_processing","conflicted","expired"],"uniqueKey":"webhook_details.oneOf.0.refund_statuses_enabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"List of refund statuses that triggers a webhook for refunds","example":["success","failure"],"isRequired":true,"uniqueKey":"webhook_details.oneOf.0.refund_statuses_enabled","typeLabel":"enum\u003cstring>[]"},"webhook_version":{"oneOf":[{"type":"string","description":"The version for Webhook","example":"1.0.2","maxLength":255,"uniqueKey":"webhook_details.oneOf.0.webhook_version.oneOf.0","typeLabel":"string"},{"type":"null","description":"The version for Webhook","example":"1.0.2","maxLength":255,"uniqueKey":"webhook_details.oneOf.0.webhook_version.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.webhook_version","typeLabel":"string | null"},"webhook_username":{"oneOf":[{"type":"string","description":"The user name for Webhook login","example":"ekart_retail","maxLength":255,"uniqueKey":"webhook_details.oneOf.0.webhook_username.oneOf.0","typeLabel":"string"},{"type":"null","description":"The user name for Webhook login","example":"ekart_retail","maxLength":255,"uniqueKey":"webhook_details.oneOf.0.webhook_username.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.webhook_username","typeLabel":"string | null"},"webhook_password":{"oneOf":[{"type":"string","description":"The password for Webhook login","example":"ekart@123","maxLength":255,"uniqueKey":"webhook_details.oneOf.0.webhook_password.oneOf.0","typeLabel":"string"},{"type":"null","description":"The password for Webhook login","example":"ekart@123","maxLength":255,"uniqueKey":"webhook_details.oneOf.0.webhook_password.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.webhook_password","typeLabel":"string | null"},"webhook_url":{"oneOf":[{"type":"string","description":"The url for the webhook endpoint","example":"www.ekart.com/webhooks","uniqueKey":"webhook_details.oneOf.0.webhook_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The url for the webhook endpoint","example":"www.ekart.com/webhooks","uniqueKey":"webhook_details.oneOf.0.webhook_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.webhook_url","typeLabel":"string | null"},"payment_created_enabled":{"oneOf":[{"type":"boolean","description":"If this property is true, a webhook message is posted whenever a new payment is created","example":true,"uniqueKey":"webhook_details.oneOf.0.payment_created_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If this property is true, a webhook message is posted whenever a new payment is created","example":true,"uniqueKey":"webhook_details.oneOf.0.payment_created_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.payment_created_enabled","typeLabel":"boolean | null"},"payment_succeeded_enabled":{"oneOf":[{"type":"boolean","description":"If this property is true, a webhook message is posted whenever a payment is successful","example":true,"uniqueKey":"webhook_details.oneOf.0.payment_succeeded_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If this property is true, a webhook message is posted whenever a payment is successful","example":true,"uniqueKey":"webhook_details.oneOf.0.payment_succeeded_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.payment_succeeded_enabled","typeLabel":"boolean | null"},"payment_failed_enabled":{"oneOf":[{"type":"boolean","description":"If this property is true, a webhook message is posted whenever a payment fails","example":true,"uniqueKey":"webhook_details.oneOf.0.payment_failed_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If this property is true, a webhook message is posted whenever a payment fails","example":true,"uniqueKey":"webhook_details.oneOf.0.payment_failed_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.payment_failed_enabled","typeLabel":"boolean | null"},"payout_statuses_enabled":{"oneOf":[{"type":"array","items":{"type":"string","enum":["success","failed","cancelled","initiated","expired","reversed","pending","ineligible","requires_creation","requires_confirmation","requires_payout_method_data","requires_fulfillment","requires_vendor_account_creation"],"uniqueKey":"webhook_details.oneOf.0.payout_statuses_enabled.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"List of payout statuses that triggers a webhook for payouts","example":["success","failed"],"uniqueKey":"webhook_details.oneOf.0.payout_statuses_enabled.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"type":"string","enum":["success","failed","cancelled","initiated","expired","reversed","pending","ineligible","requires_creation","requires_confirmation","requires_payout_method_data","requires_fulfillment","requires_vendor_account_creation"]},"description":"List of payout statuses that triggers a webhook for payouts","example":["success","failed"],"uniqueKey":"webhook_details.oneOf.0.payout_statuses_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details.oneOf.0.payout_statuses_enabled","typeLabel":"enum\u003cstring>[] | null"}},"additionalProperties":false,"uniqueKey":"webhook_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"webhook_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_details","typeLabel":"object | null"},"metadata":{"oneOf":[{"type":"object","description":"Metadata is useful for storing additional, unstructured information on an object.","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Metadata is useful for storing additional, unstructured information on an object.","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"applepay_verified_domains":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"applepay_verified_domains.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Verified Apple Pay domains for a particular profile","uniqueKey":"applepay_verified_domains.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Verified Apple Pay domains for a particular profile","uniqueKey":"applepay_verified_domains.oneOf.1","typeLabel":"null"}],"uniqueKey":"applepay_verified_domains","typeLabel":"string[] | null"},"session_expiry":{"oneOf":[{"type":"integer","format":"int64","description":"Client Secret Default expiry for all payments created under this profile","example":900,"uniqueKey":"session_expiry.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Client Secret Default expiry for all payments created under this profile","example":900,"uniqueKey":"session_expiry.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_expiry","typeLabel":"integer\u003cint64> | null"},"payment_link_config":{"oneOf":[{"type":"object","properties":{"theme":{"oneOf":[{"type":"string","description":"custom theme for the payment link","example":"#4E6ADD","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.theme.oneOf.0","typeLabel":"string"},{"type":"null","description":"custom theme for the payment link","example":"#4E6ADD","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.theme","typeLabel":"string | null"},"logo":{"oneOf":[{"type":"string","description":"merchant display logo","example":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"merchant display logo","example":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.logo","typeLabel":"string | null"},"seller_name":{"oneOf":[{"type":"string","description":"Custom merchant name for payment link","example":"hyperswitch","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.seller_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom merchant name for payment link","example":"hyperswitch","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.seller_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.seller_name","typeLabel":"string | null"},"sdk_layout":{"oneOf":[{"type":"string","description":"Custom layout for sdk","example":"accordion","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.sdk_layout.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom layout for sdk","example":"accordion","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.sdk_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.sdk_layout","typeLabel":"string | null"},"display_sdk_only":{"oneOf":[{"type":"boolean","description":"Display only the sdk for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.display_sdk_only.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Display only the sdk for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.display_sdk_only.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.display_sdk_only","typeLabel":"boolean | null"},"enabled_saved_payment_method":{"oneOf":[{"type":"boolean","description":"Enable saved payment method option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.enabled_saved_payment_method.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable saved payment method option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.enabled_saved_payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.enabled_saved_payment_method","typeLabel":"boolean | null"},"hide_card_nickname_field":{"oneOf":[{"type":"boolean","description":"Hide card nickname field option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.hide_card_nickname_field.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Hide card nickname field option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.hide_card_nickname_field.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.hide_card_nickname_field","typeLabel":"boolean | null"},"show_card_form_by_default":{"oneOf":[{"type":"boolean","description":"Show card form by default for payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.show_card_form_by_default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Show card form by default for payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.show_card_form_by_default.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.show_card_form_by_default","typeLabel":"boolean | null"},"transaction_details":{"oneOf":[{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for the transaction details","example":"Policy-Number","maxLength":255,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Value for the transaction details","example":"297472368473924","maxLength":255,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].value","typeLabel":"string"},"ui_configuration":{"oneOf":[{"type":"object","properties":{"position":{"oneOf":[{"type":"integer","format":"int32","description":"Position of the key-value pair in the UI","example":5,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Position of the key-value pair in the UI","example":5,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position","typeLabel":"integer\u003cint32> | null"},"is_key_bold":{"oneOf":[{"type":"boolean","description":"Whether the key should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the key should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold","typeLabel":"boolean | null"},"is_value_bold":{"oneOf":[{"type":"boolean","description":"Whether the value should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the value should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold","typeLabel":"boolean | null"}},"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX].ui_configuration","typeLabel":"object | null"}},"uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Dynamic details related to merchant to be rendered in payment link","uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for the transaction details","example":"Policy-Number","maxLength":255},"value":{"type":"string","description":"Value for the transaction details","example":"297472368473924","maxLength":255},"ui_configuration":{"oneOf":[{"type":"object","properties":{"position":{"oneOf":[{"type":"integer","format":"int32","description":"Position of the key-value pair in the UI","example":5},{"type":"null","format":"int32","description":"Position of the key-value pair in the UI","example":5}]},"is_key_bold":{"oneOf":[{"type":"boolean","description":"Whether the key should be bold","default":false,"example":true},{"type":"null","description":"Whether the key should be bold","default":false,"example":true}]},"is_value_bold":{"oneOf":[{"type":"boolean","description":"Whether the value should be bold","default":false,"example":true},{"type":"null","description":"Whether the value should be bold","default":false,"example":true}]}}},{"type":"null"}]}}},"description":"Dynamic details related to merchant to be rendered in payment link","uniqueKey":"payment_link_config.oneOf.0.transaction_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.transaction_details","typeLabel":"object[] | null"},"background_image":{"oneOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"URL of the image","example":"https://birrpay.io/favicon.ico","isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.url","typeLabel":"string"},"position":{"oneOf":[{"type":"string","enum":["left","top left","top","top right","right","bottom right","bottom","bottom left","center"],"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.position.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.position","typeLabel":"enum\u003cstring> | null"},"size":{"oneOf":[{"type":"object","required":["Variants"],"properties":{"Variants":{"type":"string","enum":["cover","contain"],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.0.Variants","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.0","typeLabel":"object"},{"type":"object","required":["Percentage"],"properties":{"Percentage":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.1.Percentage","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.1","typeLabel":"object"},{"type":"object","required":["Pixels"],"properties":{"Pixels":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.2.Pixels","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size.oneOf.3","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0.size","typeLabel":"object · object · object · null"}},"uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.background_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.background_image","typeLabel":"object | null"},"details_layout":{"oneOf":[{"type":"string","enum":["layout1","layout2"],"uniqueKey":"payment_link_config.oneOf.0.details_layout.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.details_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.details_layout","typeLabel":"enum\u003cstring> | null"},"payment_button_text":{"oneOf":[{"type":"string","description":"Text for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.payment_button_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.payment_button_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_button_text","typeLabel":"string | null"},"custom_message_for_card_terms":{"oneOf":[{"type":"string","description":"Text for customizing message for card terms","uniqueKey":"payment_link_config.oneOf.0.custom_message_for_card_terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text for customizing message for card terms","uniqueKey":"payment_link_config.oneOf.0.custom_message_for_card_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_card_terms","typeLabel":"string | null"},"custom_message_for_payment_method_types":{"oneOf":[{"type":"array","items":{"type":"object","description":"Custom T\u0026C messages for a specific payment method","required":["payment_method","payment_method_types"],"properties":{"payment_method":{"type":"string","description":"Indicates the type of payment method. Eg: 'card', 'wallet', etc.","enum":["card","card_redirect","pay_later","wallet","bank_redirect","bank_transfer","crypto","bank_debit","reward","real_time_payment","upi","voucher","gift_card","open_banking","mobile_payment","network_token"],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method","typeLabel":"enum\u003cstring>"},"payment_method_types":{"type":"array","items":{"type":"object","description":"Custom T\u0026C message for a specific payment method type","required":["payment_method_type","message"],"properties":{"payment_method_type":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eps","flexiti","fps","evoucher","giropay","givex","google_pay","go_pay","gcash","ideal","interac","indomaret","klarna","kakao_pay","local_bank_redirect","mandiri_va","knet","mb_way","mobile_pay","momo","momo_atm","multibanco","online_banking_thailand","online_banking_czech_republic","online_banking_finland","online_banking_fpx","online_banking_poland","online_banking_slovakia","oxxo","pago_efectivo","permata_bank_transfer","open_banking_uk","pay_bright","payjustnow","paypal","paze","pix","pay_safe_card","przelewy24","prompt_pay","pse","qris","red_compra","red_pagos","samsung_pay","sepa","sepa_bank_transfer","sepa_guarenteed_debit","skrill","sofort","swish","touch_n_go","trustly","twint","upi_collect","upi_intent","upi_qr","vipps","viet_qr","venmo","walley","we_chat_pay","seven_eleven","lawson","mini_stop","family_mart","seicomart","pay_easy","local_bank_transfer","mifinity","open_banking_pis","direct_carrier_billing","instant_bank_transfer","instant_bank_transfer_finland","instant_bank_transfer_poland","revolut_pay","indonesian_bank_transfer","open_banking","network_token"],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].payment_method_type","typeLabel":"enum\u003cstring>"},"message":{"type":"object","description":"Custom T\u0026C message content and display mode","required":["value"],"properties":{"value":{"type":"string","description":"The text to be shown per payment method type","example":"I authorize Novalnet AG to debit my account.","isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message.value","typeLabel":"string"},"display_mode":{"type":"string","description":"Display mode options for controlling how messages are shown.","enum":["default_sdk_message","custom_message","hidden"],"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message.display_mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message","typeLabel":"object"}},"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX]","typeLabel":"object"},"description":"Payment Method Types","example":[{"message":{"display_mode":"custom","value":"Sample message"},"payment_method_type":"credit"}],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types","typeLabel":"object[]"}},"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"List of custom T\u0026C messages grouped by payment method","uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.0","typeLabel":"object[]"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.custom_message_for_payment_method_types","typeLabel":"object[] | null"},"payment_button_colour":{"oneOf":[{"type":"string","description":"Custom background colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.payment_button_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom background colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.payment_button_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_button_colour","typeLabel":"string | null"},"skip_status_screen":{"oneOf":[{"type":"boolean","description":"Skip the status screen after payment completion","uniqueKey":"payment_link_config.oneOf.0.skip_status_screen.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Skip the status screen after payment completion","uniqueKey":"payment_link_config.oneOf.0.skip_status_screen.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.skip_status_screen","typeLabel":"boolean | null"},"payment_button_text_colour":{"oneOf":[{"type":"string","description":"Custom text colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.payment_button_text_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom text colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.payment_button_text_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_button_text_colour","typeLabel":"string | null"},"background_colour":{"oneOf":[{"type":"string","description":"Custom background colour for the payment link","uniqueKey":"payment_link_config.oneOf.0.background_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom background colour for the payment link","uniqueKey":"payment_link_config.oneOf.0.background_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.background_colour","typeLabel":"string | null"},"sdk_ui_rules":{"oneOf":[{"type":"object","description":"SDK configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"SDK configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules.oneOf.1.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.sdk_ui_rules","typeLabel":"object | null"},"payment_link_ui_rules":{"oneOf":[{"type":"object","description":"Payment link configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"Payment link configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules.oneOf.1.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_link_ui_rules","typeLabel":"object | null"},"enable_button_only_on_form_ready":{"oneOf":[{"type":"boolean","description":"Flag to enable the button only when the payment form is ready for submission","uniqueKey":"payment_link_config.oneOf.0.enable_button_only_on_form_ready.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Flag to enable the button only when the payment form is ready for submission","uniqueKey":"payment_link_config.oneOf.0.enable_button_only_on_form_ready.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.enable_button_only_on_form_ready","typeLabel":"boolean | null"},"payment_form_header_text":{"oneOf":[{"type":"string","description":"Optional header for the SDK's payment form","uniqueKey":"payment_link_config.oneOf.0.payment_form_header_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional header for the SDK's payment form","uniqueKey":"payment_link_config.oneOf.0.payment_form_header_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_form_header_text","typeLabel":"string | null"},"payment_form_label_type":{"oneOf":[{"type":"string","enum":["above","floating","never"],"uniqueKey":"payment_link_config.oneOf.0.payment_form_label_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.payment_form_label_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_form_label_type","typeLabel":"enum\u003cstring> | null"},"show_card_terms":{"oneOf":[{"type":"string","enum":["always","auto","never"],"uniqueKey":"payment_link_config.oneOf.0.show_card_terms.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.show_card_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.show_card_terms","typeLabel":"enum\u003cstring> | null"},"is_setup_mandate_flow":{"oneOf":[{"type":"boolean","description":"Boolean to control payment button text for setup mandate calls","uniqueKey":"payment_link_config.oneOf.0.is_setup_mandate_flow.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Boolean to control payment button text for setup mandate calls","uniqueKey":"payment_link_config.oneOf.0.is_setup_mandate_flow.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.is_setup_mandate_flow","typeLabel":"boolean | null"},"color_icon_card_cvc_error":{"oneOf":[{"type":"string","description":"Hex color for the CVC icon during error state","uniqueKey":"payment_link_config.oneOf.0.color_icon_card_cvc_error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Hex color for the CVC icon during error state","uniqueKey":"payment_link_config.oneOf.0.color_icon_card_cvc_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.color_icon_card_cvc_error","typeLabel":"string | null"},"domain_name":{"oneOf":[{"type":"string","description":"Custom domain name to be used for hosting the link in your own domain","uniqueKey":"payment_link_config.oneOf.0.domain_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom domain name to be used for hosting the link in your own domain","uniqueKey":"payment_link_config.oneOf.0.domain_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.domain_name","typeLabel":"string | null"},"business_specific_configs":{"oneOf":[{"type":"object","description":"list of configs for multi theme setup","additionalProperties":{"type":"object","properties":{"theme":{"oneOf":[{"type":"string","description":"custom theme for the payment link","example":"#4E6ADD","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.theme.oneOf.0","typeLabel":"string"},{"type":"null","description":"custom theme for the payment link","example":"#4E6ADD","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.theme","typeLabel":"string | null"},"logo":{"oneOf":[{"type":"string","description":"merchant display logo","example":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"merchant display logo","example":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.logo","typeLabel":"string | null"},"seller_name":{"oneOf":[{"type":"string","description":"Custom merchant name for payment link","example":"hyperswitch","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.seller_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom merchant name for payment link","example":"hyperswitch","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.seller_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.seller_name","typeLabel":"string | null"},"sdk_layout":{"oneOf":[{"type":"string","description":"Custom layout for sdk","example":"accordion","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_layout.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom layout for sdk","example":"accordion","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_layout","typeLabel":"string | null"},"display_sdk_only":{"oneOf":[{"type":"boolean","description":"Display only the sdk for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.display_sdk_only.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Display only the sdk for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.display_sdk_only.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.display_sdk_only","typeLabel":"boolean | null"},"enabled_saved_payment_method":{"oneOf":[{"type":"boolean","description":"Enable saved payment method option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.enabled_saved_payment_method.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable saved payment method option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.enabled_saved_payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.enabled_saved_payment_method","typeLabel":"boolean | null"},"hide_card_nickname_field":{"oneOf":[{"type":"boolean","description":"Hide card nickname field option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.hide_card_nickname_field.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Hide card nickname field option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.hide_card_nickname_field.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.hide_card_nickname_field","typeLabel":"boolean | null"},"show_card_form_by_default":{"oneOf":[{"type":"boolean","description":"Show card form by default for payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.show_card_form_by_default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Show card form by default for payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.show_card_form_by_default.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.show_card_form_by_default","typeLabel":"boolean | null"},"transaction_details":{"oneOf":[{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for the transaction details","example":"Policy-Number","maxLength":255,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Value for the transaction details","example":"297472368473924","maxLength":255,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].value","typeLabel":"string"},"ui_configuration":{"oneOf":[{"type":"object","properties":{"position":{"oneOf":[{"type":"integer","format":"int32","description":"Position of the key-value pair in the UI","example":5,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Position of the key-value pair in the UI","example":5,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position","typeLabel":"integer\u003cint32> | null"},"is_key_bold":{"oneOf":[{"type":"boolean","description":"Whether the key should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the key should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold","typeLabel":"boolean | null"},"is_value_bold":{"oneOf":[{"type":"boolean","description":"Whether the value should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the value should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold","typeLabel":"boolean | null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration","typeLabel":"object | null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Dynamic details related to merchant to be rendered in payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for the transaction details","example":"Policy-Number","maxLength":255},"value":{"type":"string","description":"Value for the transaction details","example":"297472368473924","maxLength":255},"ui_configuration":{"oneOf":[{"type":"object","properties":{"position":{"oneOf":[{"type":"integer","format":"int32","description":"Position of the key-value pair in the UI","example":5},{"type":"null","format":"int32","description":"Position of the key-value pair in the UI","example":5}]},"is_key_bold":{"oneOf":[{"type":"boolean","description":"Whether the key should be bold","default":false,"example":true},{"type":"null","description":"Whether the key should be bold","default":false,"example":true}]},"is_value_bold":{"oneOf":[{"type":"boolean","description":"Whether the value should be bold","default":false,"example":true},{"type":"null","description":"Whether the value should be bold","default":false,"example":true}]}}},{"type":"null"}]}}},"description":"Dynamic details related to merchant to be rendered in payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.transaction_details","typeLabel":"object[] | null"},"background_image":{"oneOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"URL of the image","example":"https://birrpay.io/favicon.ico","isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.url","typeLabel":"string"},"position":{"oneOf":[{"type":"string","enum":["left","top left","top","top right","right","bottom right","bottom","bottom left","center"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.position.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.position","typeLabel":"enum\u003cstring> | null"},"size":{"oneOf":[{"type":"object","required":["Variants"],"properties":{"Variants":{"type":"string","enum":["cover","contain"],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.0.Variants","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.0","typeLabel":"object"},{"type":"object","required":["Percentage"],"properties":{"Percentage":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.1.Percentage","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.1","typeLabel":"object"},{"type":"object","required":["Pixels"],"properties":{"Pixels":{"type":"integer","format":"int32","minimum":0,"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.2.Pixels","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size.oneOf.3","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0.size","typeLabel":"object · object · object · null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_image","typeLabel":"object | null"},"details_layout":{"oneOf":[{"type":"string","enum":["layout1","layout2"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.details_layout.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.details_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.details_layout","typeLabel":"enum\u003cstring> | null"},"payment_button_text":{"oneOf":[{"type":"string","description":"Text for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_text","typeLabel":"string | null"},"custom_message_for_card_terms":{"oneOf":[{"type":"string","description":"Text for customizing message for card terms","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_card_terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text for customizing message for card terms","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_card_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_card_terms","typeLabel":"string | null"},"custom_message_for_payment_method_types":{"oneOf":[{"type":"array","items":{"type":"object","description":"Custom T\u0026C messages for a specific payment method","required":["payment_method","payment_method_types"],"properties":{"payment_method":{"type":"string","description":"Indicates the type of payment method. Eg: 'card', 'wallet', etc.","enum":["card","card_redirect","pay_later","wallet","bank_redirect","bank_transfer","crypto","bank_debit","reward","real_time_payment","upi","voucher","gift_card","open_banking","mobile_payment","network_token"],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method","typeLabel":"enum\u003cstring>"},"payment_method_types":{"type":"array","items":{"type":"object","description":"Custom T\u0026C message for a specific payment method type","required":["payment_method_type","message"],"properties":{"payment_method_type":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eps","flexiti","fps","evoucher","giropay","givex","google_pay","go_pay","gcash","ideal","interac","indomaret","klarna","kakao_pay","local_bank_redirect","mandiri_va","knet","mb_way","mobile_pay","momo","momo_atm","multibanco","online_banking_thailand","online_banking_czech_republic","online_banking_finland","online_banking_fpx","online_banking_poland","online_banking_slovakia","oxxo","pago_efectivo","permata_bank_transfer","open_banking_uk","pay_bright","payjustnow","paypal","paze","pix","pay_safe_card","przelewy24","prompt_pay","pse","qris","red_compra","red_pagos","samsung_pay","sepa","sepa_bank_transfer","sepa_guarenteed_debit","skrill","sofort","swish","touch_n_go","trustly","twint","upi_collect","upi_intent","upi_qr","vipps","viet_qr","venmo","walley","we_chat_pay","seven_eleven","lawson","mini_stop","family_mart","seicomart","pay_easy","local_bank_transfer","mifinity","open_banking_pis","direct_carrier_billing","instant_bank_transfer","instant_bank_transfer_finland","instant_bank_transfer_poland","revolut_pay","indonesian_bank_transfer","open_banking","network_token"],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].payment_method_type","typeLabel":"enum\u003cstring>"},"message":{"type":"object","description":"Custom T\u0026C message content and display mode","required":["value"],"properties":{"value":{"type":"string","description":"The text to be shown per payment method type","example":"I authorize Novalnet AG to debit my account.","isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message.value","typeLabel":"string"},"display_mode":{"type":"string","description":"Display mode options for controlling how messages are shown.","enum":["default_sdk_message","custom_message","hidden"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message.display_mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message","typeLabel":"object"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX]","typeLabel":"object"},"description":"Payment Method Types","example":[{"message":{"display_mode":"custom","value":"Sample message"},"payment_method_type":"credit"}],"isRequired":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types","typeLabel":"object[]"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"List of custom T\u0026C messages grouped by payment method","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.0","typeLabel":"object[]"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.custom_message_for_payment_method_types","typeLabel":"object[] | null"},"payment_button_colour":{"oneOf":[{"type":"string","description":"Custom background colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom background colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_colour","typeLabel":"string | null"},"skip_status_screen":{"oneOf":[{"type":"boolean","description":"Skip the status screen after payment completion","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.skip_status_screen.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Skip the status screen after payment completion","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.skip_status_screen.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.skip_status_screen","typeLabel":"boolean | null"},"payment_button_text_colour":{"oneOf":[{"type":"string","description":"Custom text colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_text_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom text colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_text_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_button_text_colour","typeLabel":"string | null"},"background_colour":{"oneOf":[{"type":"string","description":"Custom background colour for the payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom background colour for the payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.background_colour","typeLabel":"string | null"},"sdk_ui_rules":{"oneOf":[{"type":"object","description":"SDK configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"SDK configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules.oneOf.1.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.sdk_ui_rules","typeLabel":"object | null"},"payment_link_ui_rules":{"oneOf":[{"type":"object","description":"Payment link configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"Payment link configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules.oneOf.1.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_link_ui_rules","typeLabel":"object | null"},"enable_button_only_on_form_ready":{"oneOf":[{"type":"boolean","description":"Flag to enable the button only when the payment form is ready for submission","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.enable_button_only_on_form_ready.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Flag to enable the button only when the payment form is ready for submission","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.enable_button_only_on_form_ready.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.enable_button_only_on_form_ready","typeLabel":"boolean | null"},"payment_form_header_text":{"oneOf":[{"type":"string","description":"Optional header for the SDK's payment form","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_form_header_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional header for the SDK's payment form","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_form_header_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_form_header_text","typeLabel":"string | null"},"payment_form_label_type":{"oneOf":[{"type":"string","enum":["above","floating","never"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_form_label_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_form_label_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.payment_form_label_type","typeLabel":"enum\u003cstring> | null"},"show_card_terms":{"oneOf":[{"type":"string","enum":["always","auto","never"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.show_card_terms.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.show_card_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.show_card_terms","typeLabel":"enum\u003cstring> | null"},"is_setup_mandate_flow":{"oneOf":[{"type":"boolean","description":"Boolean to control payment button text for setup mandate calls","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.is_setup_mandate_flow.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Boolean to control payment button text for setup mandate calls","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.is_setup_mandate_flow.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.is_setup_mandate_flow","typeLabel":"boolean | null"},"color_icon_card_cvc_error":{"oneOf":[{"type":"string","description":"Hex color for the CVC icon during error state","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.color_icon_card_cvc_error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Hex color for the CVC icon during error state","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.color_icon_card_cvc_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties.color_icon_card_cvc_error","typeLabel":"string | null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.0","typeLabel":"object"},{"type":"null","description":"list of configs for multi theme setup","additionalProperties":{"type":"object","properties":{"theme":{"oneOf":[{"type":"string","description":"custom theme for the payment link","example":"#4E6ADD","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.theme.oneOf.0","typeLabel":"string"},{"type":"null","description":"custom theme for the payment link","example":"#4E6ADD","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.theme","typeLabel":"string | null"},"logo":{"oneOf":[{"type":"string","description":"merchant display logo","example":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"merchant display logo","example":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.logo","typeLabel":"string | null"},"seller_name":{"oneOf":[{"type":"string","description":"Custom merchant name for payment link","example":"hyperswitch","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.seller_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom merchant name for payment link","example":"hyperswitch","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.seller_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.seller_name","typeLabel":"string | null"},"sdk_layout":{"oneOf":[{"type":"string","description":"Custom layout for sdk","example":"accordion","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_layout.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom layout for sdk","example":"accordion","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_layout","typeLabel":"string | null"},"display_sdk_only":{"oneOf":[{"type":"boolean","description":"Display only the sdk for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.display_sdk_only.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Display only the sdk for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.display_sdk_only.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.display_sdk_only","typeLabel":"boolean | null"},"enabled_saved_payment_method":{"oneOf":[{"type":"boolean","description":"Enable saved payment method option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.enabled_saved_payment_method.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable saved payment method option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.enabled_saved_payment_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.enabled_saved_payment_method","typeLabel":"boolean | null"},"hide_card_nickname_field":{"oneOf":[{"type":"boolean","description":"Hide card nickname field option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.hide_card_nickname_field.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Hide card nickname field option for payment link","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.hide_card_nickname_field.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.hide_card_nickname_field","typeLabel":"boolean | null"},"show_card_form_by_default":{"oneOf":[{"type":"boolean","description":"Show card form by default for payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.show_card_form_by_default.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Show card form by default for payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.show_card_form_by_default.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.show_card_form_by_default","typeLabel":"boolean | null"},"transaction_details":{"oneOf":[{"type":"array","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for the transaction details","example":"Policy-Number","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Value for the transaction details","example":"297472368473924","maxLength":255,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].value","typeLabel":"string"},"ui_configuration":{"oneOf":[{"type":"object","properties":{"position":{"oneOf":[{"type":"integer","format":"int32","description":"Position of the key-value pair in the UI","example":5,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Position of the key-value pair in the UI","example":5,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.position","typeLabel":"integer\u003cint32> | null"},"is_key_bold":{"oneOf":[{"type":"boolean","description":"Whether the key should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the key should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_key_bold","typeLabel":"boolean | null"},"is_value_bold":{"oneOf":[{"type":"boolean","description":"Whether the value should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the value should be bold","default":false,"example":true,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0.is_value_bold","typeLabel":"boolean | null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX].ui_configuration","typeLabel":"object | null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Dynamic details related to merchant to be rendered in payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"Key for the transaction details","example":"Policy-Number","maxLength":255},"value":{"type":"string","description":"Value for the transaction details","example":"297472368473924","maxLength":255},"ui_configuration":{"oneOf":[{"type":"object","properties":{"position":{"oneOf":[{"type":"integer","format":"int32","description":"Position of the key-value pair in the UI","example":5},{"type":"null","format":"int32","description":"Position of the key-value pair in the UI","example":5}]},"is_key_bold":{"oneOf":[{"type":"boolean","description":"Whether the key should be bold","default":false,"example":true},{"type":"null","description":"Whether the key should be bold","default":false,"example":true}]},"is_value_bold":{"oneOf":[{"type":"boolean","description":"Whether the value should be bold","default":false,"example":true},{"type":"null","description":"Whether the value should be bold","default":false,"example":true}]}}},{"type":"null"}]}}},"description":"Dynamic details related to merchant to be rendered in payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.transaction_details","typeLabel":"object[] | null"},"background_image":{"oneOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"URL of the image","example":"https://birrpay.io/favicon.ico","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.url","typeLabel":"string"},"position":{"oneOf":[{"type":"string","enum":["left","top left","top","top right","right","bottom right","bottom","bottom left","center"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.position.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.position.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.position","typeLabel":"enum\u003cstring> | null"},"size":{"oneOf":[{"type":"object","required":["Variants"],"properties":{"Variants":{"type":"string","enum":["cover","contain"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.0.Variants","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.0","typeLabel":"object"},{"type":"object","required":["Percentage"],"properties":{"Percentage":{"type":"integer","format":"int32","minimum":0,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.1.Percentage","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.1","typeLabel":"object"},{"type":"object","required":["Pixels"],"properties":{"Pixels":{"type":"integer","format":"int32","minimum":0,"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.2.Pixels","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size.oneOf.3","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0.size","typeLabel":"object · object · object · null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_image","typeLabel":"object | null"},"details_layout":{"oneOf":[{"type":"string","enum":["layout1","layout2"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.details_layout.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.details_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.details_layout","typeLabel":"enum\u003cstring> | null"},"payment_button_text":{"oneOf":[{"type":"string","description":"Text for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_text","typeLabel":"string | null"},"custom_message_for_card_terms":{"oneOf":[{"type":"string","description":"Text for customizing message for card terms","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_card_terms.oneOf.0","typeLabel":"string"},{"type":"null","description":"Text for customizing message for card terms","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_card_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_card_terms","typeLabel":"string | null"},"custom_message_for_payment_method_types":{"oneOf":[{"type":"array","items":{"type":"object","description":"Custom T\u0026C messages for a specific payment method","required":["payment_method","payment_method_types"],"properties":{"payment_method":{"type":"string","description":"Indicates the type of payment method. Eg: 'card', 'wallet', etc.","enum":["card","card_redirect","pay_later","wallet","bank_redirect","bank_transfer","crypto","bank_debit","reward","real_time_payment","upi","voucher","gift_card","open_banking","mobile_payment","network_token"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method","typeLabel":"enum\u003cstring>"},"payment_method_types":{"type":"array","items":{"type":"object","description":"Custom T\u0026C message for a specific payment method type","required":["payment_method_type","message"],"properties":{"payment_method_type":{"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":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].payment_method_type","typeLabel":"enum\u003cstring>"},"message":{"type":"object","description":"Custom T\u0026C message content and display mode","required":["value"],"properties":{"value":{"type":"string","description":"The text to be shown per payment method type","example":"I authorize Novalnet AG to debit my account.","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message.value","typeLabel":"string"},"display_mode":{"type":"string","description":"Display mode options for controlling how messages are shown.","enum":["default_sdk_message","custom_message","hidden"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message.display_mode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX].message","typeLabel":"object"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types.items.[INDEX]","typeLabel":"object"},"description":"Payment Method Types","example":[{"message":{"display_mode":"custom","value":"Sample message"},"payment_method_type":"credit"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX].payment_method_types","typeLabel":"object[]"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"List of custom T\u0026C messages grouped by payment method","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.0","typeLabel":"object[]"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.custom_message_for_payment_method_types","typeLabel":"object[] | null"},"payment_button_colour":{"oneOf":[{"type":"string","description":"Custom background colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom background colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_colour","typeLabel":"string | null"},"skip_status_screen":{"oneOf":[{"type":"boolean","description":"Skip the status screen after payment completion","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.skip_status_screen.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Skip the status screen after payment completion","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.skip_status_screen.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.skip_status_screen","typeLabel":"boolean | null"},"payment_button_text_colour":{"oneOf":[{"type":"string","description":"Custom text colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_text_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom text colour for payment link's handle confirm button","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_text_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_button_text_colour","typeLabel":"string | null"},"background_colour":{"oneOf":[{"type":"string","description":"Custom background colour for the payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_colour.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom background colour for the payment link","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_colour.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.background_colour","typeLabel":"string | null"},"sdk_ui_rules":{"oneOf":[{"type":"object","description":"SDK configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"SDK configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules.oneOf.1.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.sdk_ui_rules","typeLabel":"object | null"},"payment_link_ui_rules":{"oneOf":[{"type":"object","description":"Payment link configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules.oneOf.0.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules.oneOf.0","typeLabel":"object"},{"type":"null","description":"Payment link configuration rules","additionalProperties":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules.oneOf.1.additionalProperties.additionalProperties","typeLabel":"string"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_link_ui_rules","typeLabel":"object | null"},"enable_button_only_on_form_ready":{"oneOf":[{"type":"boolean","description":"Flag to enable the button only when the payment form is ready for submission","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.enable_button_only_on_form_ready.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Flag to enable the button only when the payment form is ready for submission","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.enable_button_only_on_form_ready.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.enable_button_only_on_form_ready","typeLabel":"boolean | null"},"payment_form_header_text":{"oneOf":[{"type":"string","description":"Optional header for the SDK's payment form","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_form_header_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional header for the SDK's payment form","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_form_header_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_form_header_text","typeLabel":"string | null"},"payment_form_label_type":{"oneOf":[{"type":"string","enum":["above","floating","never"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_form_label_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_form_label_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.payment_form_label_type","typeLabel":"enum\u003cstring> | null"},"show_card_terms":{"oneOf":[{"type":"string","enum":["always","auto","never"],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.show_card_terms.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.show_card_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.show_card_terms","typeLabel":"enum\u003cstring> | null"},"is_setup_mandate_flow":{"oneOf":[{"type":"boolean","description":"Boolean to control payment button text for setup mandate calls","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.is_setup_mandate_flow.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Boolean to control payment button text for setup mandate calls","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.is_setup_mandate_flow.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.is_setup_mandate_flow","typeLabel":"boolean | null"},"color_icon_card_cvc_error":{"oneOf":[{"type":"string","description":"Hex color for the CVC icon during error state","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.color_icon_card_cvc_error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Hex color for the CVC icon during error state","uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.color_icon_card_cvc_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties.color_icon_card_cvc_error","typeLabel":"string | null"}},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.business_specific_configs","typeLabel":"object | null"},"allowed_domains":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"payment_link_config.oneOf.0.allowed_domains.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"A list of allowed domains (glob patterns) where this link can be embedded / opened from","uniqueItems":true,"uniqueKey":"payment_link_config.oneOf.0.allowed_domains.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"A list of allowed domains (glob patterns) where this link can be embedded / opened from","uniqueItems":true,"uniqueKey":"payment_link_config.oneOf.0.allowed_domains.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.allowed_domains","typeLabel":"string[] | null"},"branding_visibility":{"oneOf":[{"type":"boolean","description":"Toggle for HyperSwitch branding visibility","uniqueKey":"payment_link_config.oneOf.0.branding_visibility.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Toggle for HyperSwitch branding visibility","uniqueKey":"payment_link_config.oneOf.0.branding_visibility.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.branding_visibility","typeLabel":"boolean | null"}},"uniqueKey":"payment_link_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payment_link_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config","typeLabel":"object | null"},"authentication_connector_details":{"oneOf":[{"type":"object","required":["authentication_connectors","three_ds_requestor_url"],"properties":{"authentication_connectors":{"type":"array","items":{"type":"string","enum":["threedsecureio","netcetera","gpayments","ctp_mastercard","unified_authentication_service","juspaythreedsserver","ctp_visa","cardinal"],"uniqueKey":"authentication_connector_details.oneOf.0.authentication_connectors.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"List of authentication connectors","isRequired":true,"uniqueKey":"authentication_connector_details.oneOf.0.authentication_connectors","typeLabel":"enum\u003cstring>[]"},"three_ds_requestor_url":{"type":"string","description":"URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.","isRequired":true,"uniqueKey":"authentication_connector_details.oneOf.0.three_ds_requestor_url","typeLabel":"string"},"three_ds_requestor_app_url":{"oneOf":[{"type":"string","description":"Merchant app declaring their URL within the CReq message so that the Authentication app can call the Merchant app after OOB authentication has occurred.","uniqueKey":"authentication_connector_details.oneOf.0.three_ds_requestor_app_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant app declaring their URL within the CReq message so that the Authentication app can call the Merchant app after OOB authentication has occurred.","uniqueKey":"authentication_connector_details.oneOf.0.three_ds_requestor_app_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_connector_details.oneOf.0.three_ds_requestor_app_url","typeLabel":"string | null"}},"uniqueKey":"authentication_connector_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"authentication_connector_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_connector_details","typeLabel":"object | null"},"use_billing_as_payment_method_billing":{"oneOf":[{"type":"boolean","uniqueKey":"use_billing_as_payment_method_billing.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"use_billing_as_payment_method_billing.oneOf.1","typeLabel":"null"}],"uniqueKey":"use_billing_as_payment_method_billing","typeLabel":"boolean | null"},"extended_card_info_config":{"oneOf":[{"type":"object","required":["public_key"],"properties":{"public_key":{"type":"string","description":"Merchant public key","isRequired":true,"uniqueKey":"extended_card_info_config.oneOf.0.public_key","typeLabel":"string"},"ttl_in_secs":{"type":"integer","format":"int32","description":"TTL for extended card info","default":900,"maximum":7200,"minimum":0,"uniqueKey":"extended_card_info_config.oneOf.0.ttl_in_secs","typeLabel":"integer\u003cint32>"}},"uniqueKey":"extended_card_info_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"extended_card_info_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"extended_card_info_config","typeLabel":"object | null"},"collect_shipping_details_from_wallet_connector_if_required":{"oneOf":[{"type":"boolean","description":"A boolean value to indicate if customer shipping details needs to be collected from wallet\nconnector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)","default":false,"example":false,"uniqueKey":"collect_shipping_details_from_wallet_connector_if_required.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"A boolean value to indicate if customer shipping details needs to be collected from wallet\nconnector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)","default":false,"example":false,"uniqueKey":"collect_shipping_details_from_wallet_connector_if_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"collect_shipping_details_from_wallet_connector_if_required","typeLabel":"boolean | null"},"collect_billing_details_from_wallet_connector_if_required":{"oneOf":[{"type":"boolean","description":"A boolean value to indicate if customer billing details needs to be collected from wallet\nconnector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)","default":false,"example":false,"uniqueKey":"collect_billing_details_from_wallet_connector_if_required.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"A boolean value to indicate if customer billing details needs to be collected from wallet\nconnector only if it is required field for connector (Eg. Apple Pay, Google Pay etc)","default":false,"example":false,"uniqueKey":"collect_billing_details_from_wallet_connector_if_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"collect_billing_details_from_wallet_connector_if_required","typeLabel":"boolean | null"},"always_collect_shipping_details_from_wallet_connector":{"oneOf":[{"type":"boolean","description":"A boolean value to indicate if customer shipping details needs to be collected from wallet\nconnector irrespective of connector required fields (Eg. Apple pay, Google pay etc)","default":false,"example":false,"uniqueKey":"always_collect_shipping_details_from_wallet_connector.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"A boolean value to indicate if customer shipping details needs to be collected from wallet\nconnector irrespective of connector required fields (Eg. Apple pay, Google pay etc)","default":false,"example":false,"uniqueKey":"always_collect_shipping_details_from_wallet_connector.oneOf.1","typeLabel":"null"}],"uniqueKey":"always_collect_shipping_details_from_wallet_connector","typeLabel":"boolean | null"},"always_collect_billing_details_from_wallet_connector":{"oneOf":[{"type":"boolean","description":"A boolean value to indicate if customer billing details needs to be collected from wallet\nconnector irrespective of connector required fields (Eg. Apple pay, Google pay etc)","default":false,"example":false,"uniqueKey":"always_collect_billing_details_from_wallet_connector.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"A boolean value to indicate if customer billing details needs to be collected from wallet\nconnector irrespective of connector required fields (Eg. Apple pay, Google pay etc)","default":false,"example":false,"uniqueKey":"always_collect_billing_details_from_wallet_connector.oneOf.1","typeLabel":"null"}],"uniqueKey":"always_collect_billing_details_from_wallet_connector","typeLabel":"boolean | null"},"is_connector_agnostic_mit_enabled":{"oneOf":[{"type":"boolean","description":"Indicates if the MIT (merchant initiated transaction) payments can be made connector\nagnostic, i.e., MITs may be processed through different connector than CIT (customer\ninitiated transaction) based on the routing rules.\nIf set to `false`, MIT will go through the same connector as the CIT.","uniqueKey":"is_connector_agnostic_mit_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if the MIT (merchant initiated transaction) payments can be made connector\nagnostic, i.e., MITs may be processed through different connector than CIT (customer\ninitiated transaction) based on the routing rules.\nIf set to `false`, MIT will go through the same connector as the CIT.","uniqueKey":"is_connector_agnostic_mit_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_connector_agnostic_mit_enabled","typeLabel":"boolean | null"},"payout_link_config":{"oneOf":[{"type":"object","description":"Object for GenericLinkUiConfig","required":["allowed_domains"],"properties":{"allowed_domains":{"type":"array","items":{"type":"string","uniqueKey":"payout_link_config.oneOf.0.allowed_domains.items.[INDEX]","typeLabel":"string"},"description":"A list of allowed domains (glob patterns) where this link can be embedded / opened from","uniqueItems":true,"isRequired":true,"uniqueKey":"payout_link_config.oneOf.0.allowed_domains","typeLabel":"string[]"},"logo":{"oneOf":[{"type":"string","description":"Merchant's display logo","example":"https://birrpay.io/favicon.ico","maxLength":255,"uniqueKey":"payout_link_config.oneOf.0.logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant's display logo","example":"https://birrpay.io/favicon.ico","maxLength":255,"uniqueKey":"payout_link_config.oneOf.0.logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config.oneOf.0.logo","typeLabel":"string | null"},"merchant_name":{"oneOf":[{"type":"string","description":"Custom merchant name for the link","example":"BirrPay","maxLength":255,"uniqueKey":"payout_link_config.oneOf.0.merchant_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom merchant name for the link","example":"BirrPay","maxLength":255,"uniqueKey":"payout_link_config.oneOf.0.merchant_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config.oneOf.0.merchant_name","typeLabel":"string | null"},"theme":{"oneOf":[{"type":"string","description":"Primary color to be used in the form represented in hex format","example":"#4285F4","maxLength":255,"uniqueKey":"payout_link_config.oneOf.0.theme.oneOf.0","typeLabel":"string"},{"type":"null","description":"Primary color to be used in the form represented in hex format","example":"#4285F4","maxLength":255,"uniqueKey":"payout_link_config.oneOf.0.theme.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config.oneOf.0.theme","typeLabel":"string | null"},"domain_name":{"oneOf":[{"type":"string","description":"Custom domain name to be used for hosting the link","uniqueKey":"payout_link_config.oneOf.0.domain_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom domain name to be used for hosting the link","uniqueKey":"payout_link_config.oneOf.0.domain_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config.oneOf.0.domain_name","typeLabel":"string | null"},"form_layout":{"oneOf":[{"type":"string","enum":["tabs","journey"],"uniqueKey":"payout_link_config.oneOf.0.form_layout.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"payout_link_config.oneOf.0.form_layout.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config.oneOf.0.form_layout","typeLabel":"enum\u003cstring> | null"},"payout_test_mode":{"oneOf":[{"type":"boolean","description":"Allows for removing any validations / pre-requisites which are necessary in a production environment","default":false,"uniqueKey":"payout_link_config.oneOf.0.payout_test_mode.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Allows for removing any validations / pre-requisites which are necessary in a production environment","default":false,"uniqueKey":"payout_link_config.oneOf.0.payout_test_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config.oneOf.0.payout_test_mode","typeLabel":"boolean | null"}},"uniqueKey":"payout_link_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"payout_link_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"payout_link_config","typeLabel":"object | null"},"outgoing_webhook_custom_http_headers":{"oneOf":[{"type":"object","description":"These key-value pairs are sent as additional custom headers in the outgoing webhook request.","uniqueKey":"outgoing_webhook_custom_http_headers.oneOf.0","typeLabel":"object"},{"type":"null","description":"These key-value pairs are sent as additional custom headers in the outgoing webhook request.","uniqueKey":"outgoing_webhook_custom_http_headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"outgoing_webhook_custom_http_headers","typeLabel":"object | null"},"order_fulfillment_time":{"oneOf":[{"type":"integer","format":"int32","description":"Will be used to determine the time till which your payment will be active once the payment session starts","example":900,"minimum":0,"uniqueKey":"order_fulfillment_time.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Will be used to determine the time till which your payment will be active once the payment session starts","example":900,"minimum":0,"uniqueKey":"order_fulfillment_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_fulfillment_time","typeLabel":"integer\u003cint32> | null"},"order_fulfillment_time_origin":{"oneOf":[{"type":"string","enum":["create","confirm"],"uniqueKey":"order_fulfillment_time_origin.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"order_fulfillment_time_origin.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_fulfillment_time_origin","typeLabel":"enum\u003cstring> | null"},"tax_connector_id":{"oneOf":[{"type":"string","description":"Merchant Connector id to be stored for tax_calculator connector","uniqueKey":"tax_connector_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant Connector id to be stored for tax_calculator connector","uniqueKey":"tax_connector_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax_connector_id","typeLabel":"string | null"},"should_collect_cvv_during_payment":{"oneOf":[{"type":"boolean","description":"Indicates if CVV should be collected during payment or not.","uniqueKey":"should_collect_cvv_during_payment.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if CVV should be collected during payment or not.","uniqueKey":"should_collect_cvv_during_payment.oneOf.1","typeLabel":"null"}],"uniqueKey":"should_collect_cvv_during_payment","typeLabel":"boolean | null"},"authentication_product_ids":{"oneOf":[{"type":"object","description":"Product authentication ids","uniqueKey":"authentication_product_ids.oneOf.0","typeLabel":"object"},{"type":"null","description":"Product authentication ids","uniqueKey":"authentication_product_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_product_ids","typeLabel":"object | null"},"card_testing_guard_config":{"oneOf":[{"type":"object","required":["card_ip_blocking_status","card_ip_blocking_threshold","guest_user_card_blocking_status","guest_user_card_blocking_threshold","customer_id_blocking_status","customer_id_blocking_threshold","card_testing_guard_expiry"],"properties":{"card_ip_blocking_status":{"type":"string","enum":["enabled","disabled"],"isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.card_ip_blocking_status","typeLabel":"enum\u003cstring>"},"card_ip_blocking_threshold":{"type":"integer","format":"int32","description":"Determines the unsuccessful payment threshold for Card IP Blocking for profile","isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.card_ip_blocking_threshold","typeLabel":"integer\u003cint32>"},"guest_user_card_blocking_status":{"type":"string","enum":["enabled","disabled"],"isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.guest_user_card_blocking_status","typeLabel":"enum\u003cstring>"},"guest_user_card_blocking_threshold":{"type":"integer","format":"int32","description":"Determines the unsuccessful payment threshold for Guest User Card Blocking for profile","isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.guest_user_card_blocking_threshold","typeLabel":"integer\u003cint32>"},"customer_id_blocking_status":{"type":"string","enum":["enabled","disabled"],"isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.customer_id_blocking_status","typeLabel":"enum\u003cstring>"},"customer_id_blocking_threshold":{"type":"integer","format":"int32","description":"Determines the unsuccessful payment threshold for Customer Id Blocking for profile","isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.customer_id_blocking_threshold","typeLabel":"integer\u003cint32>"},"card_testing_guard_expiry":{"type":"integer","format":"int32","description":"Determines Redis Expiry for Card Testing Guard for profile","isRequired":true,"uniqueKey":"card_testing_guard_config.oneOf.0.card_testing_guard_expiry","typeLabel":"integer\u003cint32>"}},"uniqueKey":"card_testing_guard_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"card_testing_guard_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"card_testing_guard_config","typeLabel":"object | null"},"is_debit_routing_enabled":{"oneOf":[{"type":"boolean","description":"Indicates if debit routing is enabled or not","uniqueKey":"is_debit_routing_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if debit routing is enabled or not","uniqueKey":"is_debit_routing_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_debit_routing_enabled","typeLabel":"boolean | null"},"merchant_business_country":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"merchant_business_country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"merchant_business_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_business_country","typeLabel":"enum\u003cstring> | null"},"is_iframe_redirection_enabled":{"oneOf":[{"type":"boolean","description":"Indicates if the redirection has to open in the iframe","example":false,"uniqueKey":"is_iframe_redirection_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if the redirection has to open in the iframe","example":false,"uniqueKey":"is_iframe_redirection_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_iframe_redirection_enabled","typeLabel":"boolean | null"},"is_external_vault_enabled":{"oneOf":[{"type":"boolean","description":"Indicates if external vault is enabled or not.","uniqueKey":"is_external_vault_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if external vault is enabled or not.","uniqueKey":"is_external_vault_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_external_vault_enabled","typeLabel":"boolean | null"},"external_vault_connector_details":{"oneOf":[{"type":"object","properties":{"vault_connector_id":{"oneOf":[{"type":"string","description":"Merchant Connector id to be stored for vault connector","uniqueKey":"external_vault_connector_details.oneOf.0.vault_connector_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant Connector id to be stored for vault connector","uniqueKey":"external_vault_connector_details.oneOf.0.vault_connector_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_vault_connector_details.oneOf.0.vault_connector_id","typeLabel":"string | null"},"vault_sdk":{"oneOf":[{"type":"string","enum":["vgs_sdk","hyperswitch_sdk"],"uniqueKey":"external_vault_connector_details.oneOf.0.vault_sdk.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"external_vault_connector_details.oneOf.0.vault_sdk.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_vault_connector_details.oneOf.0.vault_sdk","typeLabel":"enum\u003cstring> | null"},"vault_token_selector":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"token_type":{"oneOf":[{"type":"string","description":"Fields that can be tokenized with vault","enum":["card_number","card_cvc","card_expiry_year","card_expiry_month","network_token","network_token_expiry_year","network_token_expiry_month","network_token_cryptogram"],"uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector.oneOf.0.items.[INDEX].token_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector.oneOf.0.items.[INDEX].token_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector.oneOf.0.items.[INDEX].token_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Fields to tokenization in vault","uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"token_type":{"oneOf":[{"type":"string","description":"Fields that can be tokenized with vault","enum":["card_number","card_cvc","card_expiry_year","card_expiry_month","network_token","network_token_expiry_year","network_token_expiry_month","network_token_cryptogram"]},{"type":"null"}]}}},"description":"Fields to tokenization in vault","uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_vault_connector_details.oneOf.0.vault_token_selector","typeLabel":"object[] | null"}},"uniqueKey":"external_vault_connector_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"external_vault_connector_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_vault_connector_details","typeLabel":"object | null"},"merchant_category_code":{"oneOf":[{"type":"string","title":"4 digit Merchant category code (MCC)","example":"5411","uniqueKey":"merchant_category_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"merchant_category_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_category_code","typeLabel":"string | null"},"merchant_country_code":{"oneOf":[{"type":"string","description":"A wrapper type for merchant country codes that provides validation and conversion functionality.\n\nThis type stores a country code as a string and provides methods to validate it\nand convert it to a `Country` enum variant.","uniqueKey":"merchant_country_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"merchant_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_country_code","typeLabel":"string | null"},"revenue_recovery_retry_algorithm_type":{"oneOf":[{"type":"string","enum":["monitoring","smart","cascading"],"uniqueKey":"revenue_recovery_retry_algorithm_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"revenue_recovery_retry_algorithm_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"revenue_recovery_retry_algorithm_type","typeLabel":"enum\u003cstring> | null"},"billing_processor_id":{"oneOf":[{"type":"string","description":"Merchant Connector id to be stored for billing_processor connector","uniqueKey":"billing_processor_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant Connector id to be stored for billing_processor connector","uniqueKey":"billing_processor_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing_processor_id","typeLabel":"string | null"},"is_l2_l3_enabled":{"oneOf":[{"type":"boolean","description":"Flag to enable Level 2 and Level 3 processing data for card transactions","uniqueKey":"is_l2_l3_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Flag to enable Level 2 and Level 3 processing data for card transactions","uniqueKey":"is_l2_l3_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_l2_l3_enabled","typeLabel":"boolean | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"merchant_id":"y3oqhf46pyzuxjbcn2giaqnb44","id":"pro_abcdefghijklmnopqrstuvwxyz","profile_name":"\u003cstring>","enable_payment_response_hash":true,"redirect_to_merchant_with_http_post":true,"is_tax_connector_enabled":true,"is_network_tokenization_enabled":false,"is_click_to_pay_enabled":false,"is_clear_pan_retries_enabled":true,"split_txns_enabled":"skip","return_url":"https://www.example.com/success","payment_response_hash_key":"\u003cstring>","webhook_details":{"payment_statuses_enabled":["succeeded","failed","partially_captured","requires_merchant_action"],"refund_statuses_enabled":["success","failure"],"webhook_version":"1.0.2","webhook_username":"ekart_retail","webhook_password":"ekart@123","webhook_url":"www.ekart.com/webhooks","payment_created_enabled":true,"payment_succeeded_enabled":true,"payment_failed_enabled":true,"payout_statuses_enabled":["success","failed"]},"metadata":{},"applepay_verified_domains":["\u003cstring>"],"session_expiry":900,"payment_link_config":{"theme":"#4E6ADD","logo":"https://i.pinimg.com/736x/4d/83/5c/4d835ca8aafbbb15f84d07d926fda473.jpg","seller_name":"hyperswitch","sdk_layout":"accordion","display_sdk_only":true,"enabled_saved_payment_method":true,"hide_card_nickname_field":true,"show_card_form_by_default":true,"transaction_details":[{"key":"Policy-Number","value":"297472368473924","ui_configuration":{"position":5,"is_key_bold":true,"is_value_bold":true}}],"background_image":{"url":"https://birrpay.io/favicon.ico","position":"left","size":{"Variants":"cover"}},"details_layout":"layout1","payment_button_text":"\u003cstring>","custom_message_for_card_terms":"\u003cstring>","custom_message_for_payment_method_types":[{"payment_method":"card","payment_method_types":[{"message":{"display_mode":"custom","value":"Sample message"},"payment_method_type":"credit"}]}],"payment_button_colour":"\u003cstring>","skip_status_screen":true,"payment_button_text_colour":"\u003cstring>","background_colour":"\u003cstring>","sdk_ui_rules":{},"payment_link_ui_rules":{},"enable_button_only_on_form_ready":true,"payment_form_header_text":"\u003cstring>","payment_form_label_type":"above","show_card_terms":"always","is_setup_mandate_flow":true,"color_icon_card_cvc_error":"\u003cstring>","domain_name":"\u003cstring>","business_specific_configs":{},"allowed_domains":["\u003cstring>"],"branding_visibility":true},"authentication_connector_details":{"authentication_connectors":["threedsecureio"],"three_ds_requestor_url":"\u003cstring>","three_ds_requestor_app_url":"\u003cstring>"},"use_billing_as_payment_method_billing":true,"extended_card_info_config":{"public_key":"\u003cstring>","ttl_in_secs":900},"collect_shipping_details_from_wallet_connector_if_required":false,"collect_billing_details_from_wallet_connector_if_required":false,"always_collect_shipping_details_from_wallet_connector":false,"always_collect_billing_details_from_wallet_connector":false,"is_connector_agnostic_mit_enabled":true,"payout_link_config":{"allowed_domains":["\u003cstring>"],"logo":"https://birrpay.io/favicon.ico","merchant_name":"BirrPay","theme":"#4285F4","domain_name":"\u003cstring>","form_layout":"tabs","payout_test_mode":false},"outgoing_webhook_custom_http_headers":{},"order_fulfillment_time":900,"order_fulfillment_time_origin":"create","tax_connector_id":"\u003cstring>","should_collect_cvv_during_payment":true,"authentication_product_ids":{},"card_testing_guard_config":{"card_ip_blocking_status":"enabled","card_ip_blocking_threshold":123,"guest_user_card_blocking_status":"enabled","guest_user_card_blocking_threshold":123,"customer_id_blocking_status":"enabled","customer_id_blocking_threshold":123,"card_testing_guard_expiry":123},"is_debit_routing_enabled":true,"merchant_business_country":"AF","is_iframe_redirection_enabled":false,"is_external_vault_enabled":true,"external_vault_connector_details":{"vault_connector_id":"\u003cstring>","vault_sdk":"vgs_sdk","vault_token_selector":[{"token_type":"card_number"}]},"merchant_category_code":"5411","merchant_country_code":"\u003cstring>","revenue_recovery_retry_algorithm_type":"monitoring","billing_processor_id":"\u003cstring>","is_l2_l3_enabled":true}}},"exampleType":"generated"}},"exampleType":"generated"},"3f2e3952-3ac0-4887-850f-e2b68f950853":{"description":"Invalid data","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"387988a9-a989-4758-b316-8b929212c2a7":{"admin_api_key":{"type":"apiKey","in":"header","name":"Authorization","description":"Format: `admin-api-key=\u003cadmin-api-key>`\n\nAdmin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.","scopes":[]}}},"servers":{"f37e9e71-e224-445e-b50d-8bb9303c2220":{"url":"https://sandbox.birrpay.io","description":"Sandbox Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Format: `admin-api-key=\u003cadmin-api-key>`\n\nAdmin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"Format: `admin-api-key=\u003cadmin-api-key>`\n\nAdmin API keys allow you to perform some privileged actions such as creating a merchant account and Connector account. This is only used during development.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"admin_api_key","name":"Authorization"}],"title":"admin_api_key"}]},"originalFileLocation":"v2/openapi_spec_v2.json"},"subdomain":"birrpay","siteName":"BirrPay","title":"Profile - Update - BirrPay","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/introduction","matchLevel":3},"2.0.0 [BETA]":{"href":"/v2/profile/profile--update","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-24T02:55:16.698Z","originalFileLocation":"v2/profile/profile--update.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=\"Update the profile\">\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=\"Profile - Update - BirrPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update the profile\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BirrPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.birrpay.io/v2/profile/profile--update\">\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=Profile\u0026amp;title=Profile+-+Update\u0026amp;description=Update+the+*profile*\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=fc9b0112347018ede8f9f02f1eaed4614f1747e56297462eaa84e199beb15a12\">\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=\"Profile - Update - BirrPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update the profile\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://birrpay.mintlify.app/_mintlify/api/og/v2?division=Profile\u0026amp;title=Profile+-+Update\u0026amp;description=Update+the+*profile*\u0026amp;theme=838cc079bd3fa932cbeee950\u0026amp;signature=fc9b0112347018ede8f9f02f1eaed4614f1747e56297462eaa84e199beb15a12\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/birrpay/UMKKiD5ajm4x882S/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BirrPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F8EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.birrpay.io/v2/profile/profile--update\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/profile/profile--update.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.birrpay.io/#organization\",\"name\":\"BirrPay\",\"url\":\"https://docs.birrpay.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/birrpay/YnpImjYt65LKI-RI/logo/light.svg?fit=max\u0026auto=format\u0026n=YnpImjYt65LKI-RI\u0026q=85\u0026s=410fca5e1e3112fa410bfe0f1bc67731\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.birrpay.io#website\",\"name\":\"BirrPay\",\"url\":\"https://docs.birrpay.io\",\"publisher\":{\"@id\":\"https://docs.birrpay.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.birrpay.io/v2/profile/profile--update#webpage\",\"url\":\"https://docs.birrpay.io/v2/profile/profile--update\",\"name\":\"Profile - Update\",\"description\":\"Update the profile\",\"dateModified\":\"2026-01-24T02:55:16.698Z\",\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.birrpay.io/v2/profile/profile--update#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.birrpay.io/v2/profile/profile--update#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Account management APIs [BETA]\",\"item\":\"https://docs.birrpay.io/v2/organization/organization--create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Profile\",\"item\":\"https://docs.birrpay.io/v2/profile/profile--create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Profile - Update\",\"item\":\"https://docs.birrpay.io/v2/profile/profile--update\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.birrpay.io/v2/profile/profile--update#apireference\",\"headline\":\"Profile - Update\",\"name\":\"Profile - Update\",\"description\":\"Update the profile\",\"url\":\"https://docs.birrpay.io/v2/profile/profile--update\",\"mainEntityOfPage\":{\"@id\":\"https://docs.birrpay.io/v2/profile/profile--update#webpage\"},\"dateModified\":\"2026-01-24T02:55:16.698Z\",\"publisher\":{\"@id\":\"https://docs.birrpay.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.birrpay.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BirrPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"BirrPay","nav":{"global":null,"tabs":[{"tab":"Documentation","versions":[{"version":"1.0.0","pages":[{"title":"1.0.0","href":"/introduction"}]},{"version":"2.0.0 [BETA]","groups":[{"group":"Get Started [BETA]","pages":[{"title":"👋 Welcome to BirrPay API Reference","sidebarTitle":"Introduction","icon":"rectangle-code","iconType":"solid","href":"/introduction","hidden":false}]},{"group":"Essentials [BETA]","pages":[{"title":"Error Codes","href":"/essentials/error_codes"},{"title":"Rate Limits","href":"/essentials/rate_limit"},{"title":"Go-live Checklist","href":"/essentials/go-live"}]},{"group":"Payments Core APIs [BETA]","pages":[{"group":"Payments","pages":[{"openapi":"post /v2/payments/create-intent","title":"Payments - Create Intent","href":"/v2/payments/payments--create-intent"},{"openapi":"get /v2/payments/{id}/get-intent","title":"Payments - Get Intent","href":"/v2/payments/payments--get-intent"},{"openapi":"put /v2/payments/{id}/update-intent","title":"Payments - Update Intent","href":"/v2/payments/payments--update-intent"},{"openapi":"post /v2/payments/{payment_id}/create-external-sdk-tokens","title":"Payments - Session token","href":"/v2/payments/payments--session-token"},{"openapi":"get /v2/payments/{id}/payment-methods","title":"Payments - Payment Methods List","href":"/v2/payments/payments--payment-methods-list"},{"openapi":"post /v2/payments/{id}/confirm-intent","title":"Payments - Confirm Intent","href":"/v2/payments/payments--confirm-intent"},{"openapi":"get /v2/payments/{id}","title":"Payments - Get","href":"/v2/payments/payments--get"},{"openapi":"post /v2/payments","title":"Payments - Create and Confirm Intent","href":"/v2/payments/payments--create-and-confirm-intent"},{"openapi":"get /v2/payments/list","title":"Payments - List","href":"/v2/payments/payments--list"},{"openapi":"post /v2/payments/{id}/eligibility/check-balance-and-apply-pm-data","title":"Payments - Check Balance and Apply PM Data","href":"/v2/payments/payments--check-balance-and-apply-pm-data"}]},{"group":"Payment Methods","pages":[{"openapi":"post /v2/payment-methods","title":"Payment Method - Create","href":"/v2/payment-methods/payment-method--create"},{"openapi":"post /v2/payment-methods/create-intent","title":"Payment Method - Create Intent","href":"/v2/payment-methods/payment-method--create-intent"},{"openapi":"post /v2/payment-methods/{id}/confirm-intent","title":"Payment Method - Confirm Intent","href":"/v2/payment-methods/payment-method--confirm-intent"},{"openapi":"patch /v2/payment-methods/{id}/update-saved-payment-method","title":"Payment Method - Update","href":"/v2/payment-methods/payment-method--update"},{"openapi":"get /v2/payment-methods/{id}","title":"Payment Method - Retrieve","href":"/v2/payment-methods/payment-method--retrieve"},{"openapi":"delete /v2/payment-methods/{id}","title":"Payment Method - Delete","href":"/v2/payment-methods/payment-method--delete"},{"openapi":"get /v2/customers/{id}/saved-payment-methods","title":"Payment Method - List Customer Saved Payment Methods","href":"/v2/payment-methods/payment-method--list-customer-saved-payment-methods"},{"title":"List saved payment methods for a customer","href":"/v2/payment-methods/list-saved-payment-methods-for-a-customer"}]},{"group":"Network Tokenization","pages":[{"title":"Check network token status","href":"/v2/payment-methods/check-network-token-status"}]},{"group":"Payment Method Session","pages":[{"openapi":"post /v2/payment-method-sessions","title":"Payment Method Session - Create","href":"/v2/payment-method-session/payment-method-session--create"},{"openapi":"get /v2/payment-method-sessions/{id}","title":"Payment Method Session - Retrieve","href":"/v2/payment-method-session/payment-method-session--retrieve"},{"openapi":"get /v2/payment-method-sessions/{id}/list-payment-methods","title":"Payment Method Session - List Payment Methods","href":"/v2/payment-method-session/payment-method-session--list-payment-methods"},{"openapi":"put /v2/payment-method-sessions/{id}/update-saved-payment-method","title":"Payment Method Session - Update a saved payment method","href":"/v2/payment-method-session/payment-method-session--update-a-saved-payment-method"},{"openapi":"post /v2/payment-method-sessions/{id}/confirm","title":"Payment Method Session - Confirm a payment method session","href":"/v2/payment-method-session/payment-method-session--confirm-a-payment-method-session"},{"openapi":"delete /v2/payment-method-sessions/{id}","title":"Payment Method Session - Delete a saved payment method","href":"/v2/payment-method-session/payment-method-session--delete-a-saved-payment-method"}]},{"group":"Customers","pages":[{"openapi":"post /v2/customers","title":"Customers - Create","href":"/v2/customers/customers--create"},{"openapi":"get /v2/customers/{id}","title":"Customers - Retrieve","href":"/v2/customers/customers--retrieve"},{"openapi":"post /v2/customers/{id}","title":"Customers - Update","href":"/v2/customers/customers--update"},{"openapi":"delete /v2/customers/{id}","title":"Customers - Delete","href":"/v2/customers/customers--delete"},{"openapi":"get /v2/customers/list","title":"Customers - List","href":"/v2/customers/customers--list"}]},{"group":"Refunds","pages":[{"openapi":"post /v2/refunds","title":"Refunds - Create","href":"/v2/refunds/refunds--create"},{"openapi":"put /v2/refunds/{id}/update_metadata","title":null,"href":"/v2/refunds/refunds--metadata-update"},{"openapi":"get /v2/refunds/{id}","title":"Refunds - Retrieve","href":"/v2/refunds/refunds--retrieve"},{"openapi":"post /v2/refunds/list","title":"Refunds - List","href":"/v2/refunds/refunds--list"}]}]},{"group":"Account management APIs [BETA]","pages":[{"group":"Organization","pages":[{"openapi":"post /v2/organizations","title":"Organization - Create","href":"/v2/organization/organization--create"},{"openapi":"get /v2/organizations/{id}","title":"Organization - Retrieve","href":"/v2/organization/organization--retrieve"},{"openapi":"put /v2/organizations/{id}","title":"Organization - Update","href":"/v2/organization/organization--update"},{"openapi":"get /v2/organizations/{id}/merchant-accounts","title":"Organization - Merchant Account - List","href":"/v2/organization/organization--merchant-account--list"}]},{"group":"Merchant Account","pages":[{"openapi":"post /v2/merchant-accounts","title":"Merchant Account - Create","href":"/v2/merchant-account/merchant-account--create"},{"openapi":"get /v2/merchant-accounts/{id}","title":"Merchant Account - Retrieve","href":"/v2/merchant-account/merchant-account--retrieve"},{"openapi":"put /v2/merchant-accounts/{id}","title":"Merchant Account - Update","href":"/v2/merchant-account/merchant-account--update"},{"openapi":"get /v2/merchant-accounts/{id}/profiles","title":"Merchant Account - Profile List","href":"/v2/merchant-account/business-profile--list"}]},{"group":"Profile","pages":[{"openapi":"post /v2/profiles","title":"Profile - Create","description":"Creates a new *profile* for a merchant","href":"/v2/profile/profile--create"},{"openapi":"put /v2/profiles/{id}","title":"Profile - Update","href":"/v2/profile/profile--update"},{"openapi":"patch /v2/profiles/{id}/activate-routing-algorithm","title":"Profile - Activate routing algorithm","description":"Activates a routing algorithm under a profile","href":"/v2/profile/profile--activate-routing-algorithm"},{"openapi":"patch /v2/profiles/{id}/fallback-routing","title":"Profile - Update Default Fallback Routing Algorithm","href":"/v2/profile/profile--update-default-fallback-routing-algorithm"},{"openapi":"patch /v2/profiles/{id}/deactivate-routing-algorithm","title":"Profile - Deactivate routing algorithm","href":"/v2/profile/profile--deactivate-routing-algorithm"},{"openapi":"get /v2/profiles/{id}","title":"Profile - Retrieve","href":"/v2/profile/profile--retrieve"},{"openapi":"get /v2/profiles/{id}/connector-accounts","title":"Profile - Connector Accounts List","href":"/v2/profile/merchant-connector--list"},{"openapi":"get /v2/profiles/{id}/routing-algorithm","title":"Profile - Retrieve Active Routing Algorithm","href":"/v2/profile/profile--retrieve-active-routing-algorithm"},{"openapi":"get /v2/profiles/{id}/fallback-routing","title":"Profile - Retrieve Default Fallback Routing Algorithm","href":"/v2/profile/profile--retrieve-default-fallback-routing-algorithm"}]},{"group":"Connector Account","pages":[{"openapi":"post /v2/connector-accounts","title":"Connector Account - Create","href":"/v2/connector-account/connector-account--create"},{"openapi":"get /v2/connector-accounts/{id}","title":"Connector Account - Retrieve","href":"/v2/connector-account/connector-account--retrieve"},{"openapi":"put /v2/connector-accounts/{id}","title":"Connector Account - Update","href":"/v2/connector-account/connector-account--update"}]},{"group":"API Key","pages":[{"openapi":"post /v2/api-keys","title":"API Key - Create","href":"/v2/api-key/api-key--create"},{"openapi":"get /v2/api-keys/{id}","title":"API Key - Retrieve","href":"/v2/api-key/api-key--retrieve"},{"openapi":"put /v2/api-keys/{id}","title":"API Key - Update","href":"/v2/api-key/api-key--update"},{"openapi":"delete /v2/api-keys/{id}","title":"API Key - Revoke","href":"/v2/api-key/api-key--revoke"},{"openapi":"get /v2/api-keys/list","title":"API Key - List","href":"/v2/api-key/api-key--list"}]},{"group":"Routing","pages":[{"openapi":"post /v2/routing-algorithms","title":"Routing - Create","href":"/v2/routing/routing--create"},{"openapi":"get /v2/routing-algorithms/{id}","title":"Routing - Retrieve","href":"/v2/routing/routing--retrieve"}]}]},{"group":"Other APIs [BETA]","pages":[{"group":"Proxy","pages":[{"openapi":"post /proxy","title":"Proxy","href":"/v2/proxy/proxy"}]},{"group":"Tokenization","pages":[{"openapi":"post /v2/tokenize","title":"Tokenization - Create","href":"/v2/tokenization/tokenization--create"}]},{"group":"Revenue Recovery","pages":[{"openapi":"get /v2/process-trackers/revenue-recovery-workflow/{revenue_recovery_id}","title":"Revenue Recovery - Retrieve","href":"/v2/revenue-recovery/revenue-recovery--retrieve"}]}]}]}]},{"tab":"Locker API Reference","pages":[{"title":"Locker API Reference","href":"/locker-api-reference/overview"}]},{"tab":"Intelligent Router API Reference","pages":[{"title":"Intelligent Router API Reference","href":"/intelligent-router-api-reference/overview"}]}]},"title":"Profile - Update - 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"]}