Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.
Specifies the type of cardholder authentication to be applied for a payment.
ThreeDs: Requests 3D Secure (3DS) authentication. If the card is enrolled, 3DS authentication will be activated, potentially shifting chargeback liability to the issuer.
NoThreeDs: Indicates that 3D Secure authentication should not be performed. The liability for chargebacks typically remains with the merchant. This is often the default if not specified.
Note: The actual authentication behavior can also be influenced by merchant configuration and specific connector defaults. Some connectors might still enforce 3DS or bypass it regardless of this parameter.
Set to present to indicate that the customer is in your checkout flow during this payment, and therefore is able to authenticate. This parameter should be absent when merchant's doing merchant initiated payments and customer is not present while doing the payment.
For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount
Will be used to expire client secret after certain amount of time to be supplied in seconds, if not sent it will be taken from profile config
(900) for 15 mins
Request address verification using the billing address for supported card payments.
Omit this field on updates or confirmation to preserve the existing setting.
Represents the overall status of a payment intent.
The status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).
Set to present to indicate that the customer is in your checkout flow during this payment, and therefore is able to authenticate. This parameter should be absent when merchant's doing merchant initiated payments and customer is not present while doing the payment.
Specifies the type of cardholder authentication to be applied for a payment.
ThreeDs: Requests 3D Secure (3DS) authentication. If the card is enrolled, 3DS authentication will be activated, potentially shifting chargeback liability to the issuer.
NoThreeDs: Indicates that 3D Secure authentication should not be performed. The liability for chargebacks typically remains with the merchant. This is often the default if not specified.
Note: The actual authentication behavior can also be influenced by merchant configuration and specific connector defaults. Some connectors might still enforce 3DS or bypass it regardless of this parameter.
For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hyperswitch","colors":{"primary":"#4F8EFF","light":"#6BA3FF","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/juspay-78/Ofakw17OkkP9DV40/logo/light.svg?fit=max\u0026auto=format\u0026n=Ofakw17OkkP9DV40\u0026q=85\u0026s=c8a8a5613621b7f19e447e754f4a4ffa","dark":"https://mintcdn.com/juspay-78/Ofakw17OkkP9DV40/logo/dark.svg?fit=max\u0026auto=format\u0026n=Ofakw17OkkP9DV40\u0026q=85\u0026s=ba1e1063c50d5e3e6814ac1394cbe0bd"},"favicon":"https://mintcdn.com/juspay-78/lgBtlsxwQg1XCgqU/favicon.png?fit=max\u0026auto=format\u0026n=lgBtlsxwQg1XCgqU\u0026q=85\u0026s=1e2ff54d240ff03d1e663390917f2fb6","api":{"openapi":["v1/openapi_spec_v1.json","v2/openapi_spec_v2.json","rust_locker_open_api_spec.yml","decision_engine_openapi-specs.json"]},"background":{"color":{"light":"#FAFBFC","dark":"#1d1d1d"}},"navbar":{"links":[{"href":"https://inviter.co/hyperswitch-slack","label":"Contact Us"},{"href":"https://deepwiki.com/juspay/hyperswitch","label":"Explore with Deepwiki"}],"primary":{"type":"button","label":"Self-Deploy","href":"https://docs.hyperswitch.io/self-hosting"}},"footer":{"socials":{"github":"https://github.com/juspay/hyperswitch","linkedin":"https://www.linkedin.com/company/hyperswitch"}},"integrations":{"gtm":{"tagId":"GTM-PLBNKQFQ"},"mixpanel":{"projectToken":"b00355f29d9548d1333608df71d5d53d"}},"contextual":{"options":["copy","claude","chatgpt","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"juspay-78","hasAudioNarration":false,"actualSubdomain":"juspay-78","customDomains":["api-reference.hyperswitch.io"],"gitSource":{"type":"github","owner":"juspay","repo":"hyperswitch","deployBranch":"main","contentDirectory":"api-reference","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af48600517916afd7758dc7","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Documentation","count":223},{"language":"default","tag":"Decision Engine API Reference","count":121},{"language":"default","tag":"Payments Core APIs","count":69},{"language":"default","tag":"API Examples (curl flows)","count":44},{"language":"default","tag":"Other APIs","count":39},{"language":"default","tag":"Payments Core APIs [BETA]","count":33},{"language":"default","tag":"Account management APIs","count":28},{"language":"default","tag":"Payments","count":27},{"language":"default","tag":"Account management APIs [BETA]","count":27},{"language":"default","tag":"Payment Methods","count":24}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v2/payments/payments--update-intent","slug":"/v2/payments/payments--update-intent","pageMetadata":{"openapi":"put /v2/payments/{id}/update-intent","title":"Payments - Update Intent","description":"**Update a payment intent object**\n\nYou will require the 'API - Key' from the Hyperswitch dashboard to make the call.","href":"/v2/payments/payments--update-intent"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Update a payment intent object\"\n })\n }), \"\\n\", _jsx(_components.p, {\n children: \"You will require the ‘API - Key’ from the Hyperswitch dashboard to make the call.\"\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/payments/{id}/update-intent","title":"Payments - Update Intent","description":"**Update a payment intent object**\n\nYou will require the 'API - Key' from the Hyperswitch dashboard to make the call.","href":"/v2/payments/payments--update-intent"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Payments"],"summary":"Payments - Update Intent","description":"**Update a payment intent object**\n\nYou will require the 'API - Key' from the Hyperswitch dashboard to make the call.","operationId":"Update a Payment Intent","parameters":["fc61a184-c764-4826-8b22-539ed16df126","3af559d6-04a4-4838-b04d-50f3ea3d298c"],"requestBody":"5d2518de-3aaf-421a-b818-8a9b3f9971f7","responses":{"200":"358616fa-c17b-432e-a2f6-7d52af0e47c0","404":"3c74d1a2-9205-45f9-b960-211f8a116b0c"},"security":["b24a3a4c-f428-4f17-bd16-5a0786485fdc"],"method":"put","type":"path","servers":["cd155929-0a18-4604-91f3-c5456ffab5c8"],"path":"/v2/payments/{id}/update-intent","baseUrlOptions":["https://sandbox.hyperswitch.io"],"title":"Payments - Update Intent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fc61a184-c764-4826-8b22-539ed16df126":{"name":"id","in":"path","description":"The unique identifier for the Payment Intent","required":true,"schema":{"type":"string","isRequired":true,"description":"The unique identifier for the Payment Intent","uniqueKey":"","typeLabel":"string"}},"3af559d6-04a4-4838-b04d-50f3ea3d298c":{"name":"X-Profile-Id","in":"header","description":"Profile ID associated to the payment intent","required":true,"schema":{"type":"string","isRequired":true,"description":"Profile ID associated to the payment intent","uniqueKey":"","typeLabel":"string"},"example":"pro_abcdefghijklmnop"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount_details":{"oneOf":[{"type":"object","properties":{"order_amount":{"oneOf":[{"type":"integer","format":"int64","description":"The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and 1 for 1¥ since ¥ is a zero-decimal currency. Read more about [the Decimal and Non-Decimal Currencies](https://github.com/juspay/hyperswitch/wiki/Decimal-and-Non%E2%80%90Decimal-Currencies)","example":6540,"minimum":0,"uniqueKey":"amount_details.oneOf.0.order_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and 1 for 1¥ since ¥ is a zero-decimal currency. Read more about [the Decimal and Non-Decimal Currencies](https://github.com/juspay/hyperswitch/wiki/Decimal-and-Non%E2%80%90Decimal-Currencies)","example":6540,"minimum":0,"uniqueKey":"amount_details.oneOf.0.order_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.oneOf.0.order_amount","typeLabel":"integer\u003cint64> | null"},"currency":{"oneOf":[{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"uniqueKey":"amount_details.oneOf.0.currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"amount_details.oneOf.0.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.oneOf.0.currency","typeLabel":"enum\u003cstring> | null"},"shipping_cost":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64","uniqueKey":"amount_details.oneOf.0.shipping_cost.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","uniqueKey":"amount_details.oneOf.0.shipping_cost.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.oneOf.0.shipping_cost","typeLabel":"integer\u003cint64> | null"},"order_tax_amount":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64","uniqueKey":"amount_details.oneOf.0.order_tax_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","uniqueKey":"amount_details.oneOf.0.order_tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.oneOf.0.order_tax_amount","typeLabel":"integer\u003cint64> | null"},"skip_external_tax_calculation":{"oneOf":[{"type":"string","enum":["skip","calculate"],"uniqueKey":"amount_details.oneOf.0.skip_external_tax_calculation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"amount_details.oneOf.0.skip_external_tax_calculation.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.oneOf.0.skip_external_tax_calculation","typeLabel":"enum\u003cstring> | null"},"skip_surcharge_calculation":{"oneOf":[{"type":"string","enum":["skip","calculate"],"uniqueKey":"amount_details.oneOf.0.skip_surcharge_calculation.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"amount_details.oneOf.0.skip_surcharge_calculation.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.oneOf.0.skip_surcharge_calculation","typeLabel":"enum\u003cstring> | null"},"surcharge_amount":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64","uniqueKey":"amount_details.oneOf.0.surcharge_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","uniqueKey":"amount_details.oneOf.0.surcharge_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.oneOf.0.surcharge_amount","typeLabel":"integer\u003cint64> | null"},"tax_on_surcharge":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64","uniqueKey":"amount_details.oneOf.0.tax_on_surcharge.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","uniqueKey":"amount_details.oneOf.0.tax_on_surcharge.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.oneOf.0.tax_on_surcharge","typeLabel":"integer\u003cint64> | null"}},"uniqueKey":"amount_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"amount_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details","typeLabel":"object | null"},"routing_algorithm_id":{"oneOf":[{"type":"string","description":"The routing algorithm id to be used for the payment","uniqueKey":"routing_algorithm_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The routing algorithm id to be used for the payment","uniqueKey":"routing_algorithm_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"routing_algorithm_id","typeLabel":"string | null"},"capture_method":{"oneOf":[{"type":"string","description":"Specifies how the payment is captured.\n- `automatic`: Funds are captured immediately after successful authorization. This is the default behavior if the field is omitted.\n- `manual`: Funds are authorized but not captured. A separate request to the `/payments/{payment_id}/capture` endpoint is required to capture the funds.","enum":["automatic","manual","manual_multiple","scheduled","sequential_automatic"],"uniqueKey":"capture_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"capture_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"capture_method","typeLabel":"enum\u003cstring> | null"},"authentication_type":{"oneOf":[{"type":"string","description":"Specifies the type of cardholder authentication to be applied for a payment.\n\n- `ThreeDs`: Requests 3D Secure (3DS) authentication. If the card is enrolled, 3DS authentication will be activated, potentially shifting chargeback liability to the issuer.\n- `NoThreeDs`: Indicates that 3D Secure authentication should not be performed. The liability for chargebacks typically remains with the merchant. This is often the default if not specified.\n\nNote: The actual authentication behavior can also be influenced by merchant configuration and specific connector defaults. Some connectors might still enforce 3DS or bypass it regardless of this parameter.","default":"no_three_ds","enum":["three_ds","no_three_ds"],"uniqueKey":"authentication_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"authentication_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_type","typeLabel":"enum\u003cstring> | null"},"billing":{"oneOf":[{"type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"Address details","properties":{"city":{"oneOf":[{"type":"string","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"billing.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"billing.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.country","typeLabel":"enum\u003cstring> | null"},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"line3":{"oneOf":[{"type":"string","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.line3","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The address state","example":"New York","uniqueKey":"billing.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address state","example":"New York","uniqueKey":"billing.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"billing.oneOf.0.address.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"billing.oneOf.0.address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"billing.oneOf.0.address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"billing.oneOf.0.address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.last_name","typeLabel":"string | null"},"origin_zip":{"oneOf":[{"type":"string","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.origin_zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.origin_zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.origin_zip","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address","typeLabel":"object | null"},"phone":{"oneOf":[{"type":"object","description":"Phone contact details shared by payment and payout API models.","properties":{"number":{"oneOf":[{"type":"string","description":"The contact number","example":"9123456789","uniqueKey":"billing.oneOf.0.phone.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The contact number","example":"9123456789","uniqueKey":"billing.oneOf.0.phone.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone.oneOf.0.number","typeLabel":"string | null"},"country_code":{"oneOf":[{"type":"string","description":"The country code attached to the number","example":"+1","uniqueKey":"billing.oneOf.0.phone.oneOf.0.country_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The country code attached to the number","example":"+1","uniqueKey":"billing.oneOf.0.phone.oneOf.0.country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone.oneOf.0.country_code","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0.phone.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone","typeLabel":"object | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"billing.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"billing.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing","typeLabel":"object | null"},"shipping":{"oneOf":[{"type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"Address details","properties":{"city":{"oneOf":[{"type":"string","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"shipping.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.country","typeLabel":"enum\u003cstring> | null"},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"line3":{"oneOf":[{"type":"string","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line3","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The address state","example":"New York","uniqueKey":"shipping.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address state","example":"New York","uniqueKey":"shipping.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.last_name","typeLabel":"string | null"},"origin_zip":{"oneOf":[{"type":"string","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.origin_zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.origin_zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.origin_zip","typeLabel":"string | null"}},"uniqueKey":"shipping.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"shipping.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address","typeLabel":"object | null"},"phone":{"oneOf":[{"type":"object","description":"Phone contact details shared by payment and payout API models.","properties":{"number":{"oneOf":[{"type":"string","description":"The contact number","example":"9123456789","uniqueKey":"shipping.oneOf.0.phone.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The contact number","example":"9123456789","uniqueKey":"shipping.oneOf.0.phone.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.phone.oneOf.0.number","typeLabel":"string | null"},"country_code":{"oneOf":[{"type":"string","description":"The country code attached to the number","example":"+1","uniqueKey":"shipping.oneOf.0.phone.oneOf.0.country_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The country code attached to the number","example":"+1","uniqueKey":"shipping.oneOf.0.phone.oneOf.0.country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.phone.oneOf.0.country_code","typeLabel":"string | null"}},"uniqueKey":"shipping.oneOf.0.phone.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"shipping.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.phone","typeLabel":"object | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"shipping.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"shipping.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"shipping.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping","typeLabel":"object | null"},"customer_present":{"oneOf":[{"type":"string","description":"Set to `present` to indicate that the customer is in your checkout flow during this payment, and therefore is able to authenticate. This parameter should be `absent` when merchant's doing merchant initiated payments and customer is not present while doing the payment.","enum":["present","absent"],"uniqueKey":"customer_present.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"customer_present.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_present","typeLabel":"enum\u003cstring> | null"},"description":{"oneOf":[{"type":"string","description":"A description for the payment","example":"It's my first payment request","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description for the payment","example":"It's my first payment request","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"return_url":{"oneOf":[{"type":"string","description":"The URL to which you want the user to be redirected after the completion of the payment operation","example":"https://hyperswitch.io","uniqueKey":"return_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to which you want the user to be redirected after the completion of the payment operation","example":"https://hyperswitch.io","uniqueKey":"return_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"return_url","typeLabel":"string | null"},"setup_future_usage":{"oneOf":[{"type":"string","description":"Specifies how the payment method can be used for future payments.\n- `off_session`: The payment method can be used for future payments when the customer is not present.\n- `on_session`: The payment method is intended for use only when the customer is present during checkout.\n\nIf omitted, defaults to `on_session`.","enum":["off_session","on_session"],"uniqueKey":"setup_future_usage.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"setup_future_usage.oneOf.1","typeLabel":"null"}],"uniqueKey":"setup_future_usage","typeLabel":"enum\u003cstring> | null"},"apply_mit_exemption":{"oneOf":[{"type":"string","enum":["Apply","Skip"],"uniqueKey":"apply_mit_exemption.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"apply_mit_exemption.oneOf.1","typeLabel":"null"}],"uniqueKey":"apply_mit_exemption","typeLabel":"enum\u003cstring> | null"},"statement_descriptor":{"oneOf":[{"type":"string","description":"For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.","example":"Hyperswitch Router","maxLength":22,"uniqueKey":"statement_descriptor.oneOf.0","typeLabel":"string"},{"type":"null","description":"For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.","example":"Hyperswitch Router","maxLength":22,"uniqueKey":"statement_descriptor.oneOf.1","typeLabel":"null"}],"uniqueKey":"statement_descriptor","typeLabel":"string | null"},"order_details":{"oneOf":[{"type":"array","items":{"type":"object","required":["product_name","quantity","amount"],"properties":{"product_name":{"type":"string","description":"Name of the product that is being purchased","example":"shirt","maxLength":255,"isRequired":true,"uniqueKey":"order_details.oneOf.0.items.[INDEX].product_name","typeLabel":"string"},"quantity":{"type":"integer","format":"int32","description":"The quantity of the product to be purchased","example":1,"minimum":0,"isRequired":true,"uniqueKey":"order_details.oneOf.0.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"amount":{"type":"integer","format":"int64","description":"the amount per quantity of product","isRequired":true,"uniqueKey":"order_details.oneOf.0.items.[INDEX].amount","typeLabel":"integer\u003cint64>"},"tax_rate":{"oneOf":[{"type":"number","format":"double","description":"tax rate applicable to the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].tax_rate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"tax rate applicable to the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].tax_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].tax_rate","typeLabel":"number\u003cdouble> | null"},"total_tax_amount":{"oneOf":[{"type":"integer","format":"int64","description":"total tax amount applicable to the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].total_tax_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"total tax amount applicable to the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].total_tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].total_tax_amount","typeLabel":"integer\u003cint64> | null"},"requires_shipping":{"oneOf":[{"type":"boolean","uniqueKey":"order_details.oneOf.0.items.[INDEX].requires_shipping.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"order_details.oneOf.0.items.[INDEX].requires_shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].requires_shipping","typeLabel":"boolean | null"},"product_img_link":{"oneOf":[{"type":"string","description":"The image URL of the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_img_link.oneOf.0","typeLabel":"string"},{"type":"null","description":"The image URL of the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_img_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].product_img_link","typeLabel":"string | null"},"product_id":{"oneOf":[{"type":"string","description":"ID of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].product_id","typeLabel":"string | null"},"category":{"oneOf":[{"type":"string","description":"Category of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].category.oneOf.0","typeLabel":"string"},{"type":"null","description":"Category of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].category","typeLabel":"string | null"},"sub_category":{"oneOf":[{"type":"string","description":"Sub category of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].sub_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"Sub category of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].sub_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].sub_category","typeLabel":"string | null"},"brand":{"oneOf":[{"type":"string","description":"Brand of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].brand.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brand of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].brand","typeLabel":"string | null"},"product_type":{"oneOf":[{"type":"string","enum":["physical","digital","travel","ride","event","accommodation"],"uniqueKey":"order_details.oneOf.0.items.[INDEX].product_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].product_type","typeLabel":"enum\u003cstring> | null"},"product_tax_code":{"oneOf":[{"type":"string","description":"The tax code for the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_tax_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax code for the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_tax_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].product_tax_code","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Description for the item","uniqueKey":"order_details.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description for the item","uniqueKey":"order_details.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","description":"Stock Keeping Unit (SKU) or the item identifier for this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"Stock Keeping Unit (SKU) or the item identifier for this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].sku","typeLabel":"string | null"},"upc":{"oneOf":[{"type":"string","description":"Universal Product Code for the item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].upc.oneOf.0","typeLabel":"string"},{"type":"null","description":"Universal Product Code for the item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].upc.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].upc","typeLabel":"string | null"},"commodity_code":{"oneOf":[{"type":"string","description":"Code describing a commodity or a group of commodities pertaining to goods classification.","uniqueKey":"order_details.oneOf.0.items.[INDEX].commodity_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Code describing a commodity or a group of commodities pertaining to goods classification.","uniqueKey":"order_details.oneOf.0.items.[INDEX].commodity_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].commodity_code","typeLabel":"string | null"},"unit_of_measure":{"oneOf":[{"type":"string","description":"Unit of measure used for the item quantity.","uniqueKey":"order_details.oneOf.0.items.[INDEX].unit_of_measure.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unit of measure used for the item quantity.","uniqueKey":"order_details.oneOf.0.items.[INDEX].unit_of_measure.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].unit_of_measure","typeLabel":"string | null"},"total_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Total amount for the item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].total_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Total amount for the item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].total_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].total_amount","typeLabel":"integer\u003cint64> | null"},"discount_name":{"oneOf":[{"type":"string","description":"Discount name applied to this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Discount name applied to this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_name","typeLabel":"string | null"},"unit_discount_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Discount amount applied to this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].unit_discount_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Discount amount applied to this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].unit_discount_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].unit_discount_amount","typeLabel":"integer\u003cint64> | null"},"discount_percentage":{"oneOf":[{"type":"object","description":"Represents Percentage Value between 0 and 100 both inclusive","required":["percentage"],"properties":{"percentage":{"type":"number","format":"double","description":"Percentage value ranging between 0 and 100","isRequired":true,"uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_percentage.oneOf.0.percentage","typeLabel":"number\u003cdouble>"}},"uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_percentage.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_percentage","typeLabel":"object | null"},"discount_type":{"oneOf":[{"type":"string","description":"Discount type applied to this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Discount type applied to this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_type","typeLabel":"string | null"}},"uniqueKey":"order_details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount","example":"[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]","uniqueKey":"order_details.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["product_name","quantity","amount"],"properties":{"product_name":{"type":"string","description":"Name of the product that is being purchased","example":"shirt","maxLength":255},"quantity":{"type":"integer","format":"int32","description":"The quantity of the product to be purchased","example":1,"minimum":0},"amount":{"type":"integer","format":"int64","description":"the amount per quantity of product"},"tax_rate":{"oneOf":[{"type":"number","format":"double","description":"tax rate applicable to the product"},{"type":"null","format":"double","description":"tax rate applicable to the product"}]},"total_tax_amount":{"oneOf":[{"type":"integer","format":"int64","description":"total tax amount applicable to the product"},{"type":"null","format":"int64","description":"total tax amount applicable to the product"}]},"requires_shipping":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"product_img_link":{"oneOf":[{"type":"string","description":"The image URL of the product"},{"type":"null","description":"The image URL of the product"}]},"product_id":{"oneOf":[{"type":"string","description":"ID of the product that is being purchased"},{"type":"null","description":"ID of the product that is being purchased"}]},"category":{"oneOf":[{"type":"string","description":"Category of the product that is being purchased"},{"type":"null","description":"Category of the product that is being purchased"}]},"sub_category":{"oneOf":[{"type":"string","description":"Sub category of the product that is being purchased"},{"type":"null","description":"Sub category of the product that is being purchased"}]},"brand":{"oneOf":[{"type":"string","description":"Brand of the product that is being purchased"},{"type":"null","description":"Brand of the product that is being purchased"}]},"product_type":{"oneOf":[{"type":"string","enum":["physical","digital","travel","ride","event","accommodation"]},{"type":"null"}]},"product_tax_code":{"oneOf":[{"type":"string","description":"The tax code for the product"},{"type":"null","description":"The tax code for the product"}]},"description":{"oneOf":[{"type":"string","description":"Description for the item"},{"type":"null","description":"Description for the item"}]},"sku":{"oneOf":[{"type":"string","description":"Stock Keeping Unit (SKU) or the item identifier for this item."},{"type":"null","description":"Stock Keeping Unit (SKU) or the item identifier for this item."}]},"upc":{"oneOf":[{"type":"string","description":"Universal Product Code for the item."},{"type":"null","description":"Universal Product Code for the item."}]},"commodity_code":{"oneOf":[{"type":"string","description":"Code describing a commodity or a group of commodities pertaining to goods classification."},{"type":"null","description":"Code describing a commodity or a group of commodities pertaining to goods classification."}]},"unit_of_measure":{"oneOf":[{"type":"string","description":"Unit of measure used for the item quantity."},{"type":"null","description":"Unit of measure used for the item quantity."}]},"total_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Total amount for the item."},{"type":"null","format":"int64","description":"Total amount for the item."}]},"discount_name":{"oneOf":[{"type":"string","description":"Discount name applied to this item."},{"type":"null","description":"Discount name applied to this item."}]},"unit_discount_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Discount amount applied to this item."},{"type":"null","format":"int64","description":"Discount amount applied to this item."}]},"discount_percentage":{"oneOf":[{"type":"object","description":"Represents Percentage Value between 0 and 100 both inclusive","required":["percentage"],"properties":{"percentage":{"type":"number","format":"double","description":"Percentage value ranging between 0 and 100"}}},{"type":"null"}]},"discount_type":{"oneOf":[{"type":"string","description":"Discount type applied to this item."},{"type":"null","description":"Discount type applied to this item."}]}}},"description":"Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount","example":"[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]","uniqueKey":"order_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details","typeLabel":"object[] | null"},"allowed_payment_method_types":{"oneOf":[{"type":"array","items":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eft_debit_order","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","neteller","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","pix_key","pix_emv","pix_qr","pix_automatico_qr","pix_automatico_push","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","wero","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","payshap","payshap_proxy","ted"],"uniqueKey":"allowed_payment_method_types.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent","uniqueKey":"allowed_payment_method_types.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eft_debit_order","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","neteller","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","pix_key","pix_emv","pix_qr","pix_automatico_qr","pix_automatico_push","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","wero","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","payshap","payshap_proxy","ted"]},"description":"Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent","uniqueKey":"allowed_payment_method_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"allowed_payment_method_types","typeLabel":"enum\u003cstring>[] | null"},"metadata":{"oneOf":[{"type":"object","description":"Metadata is useful for storing additional, unstructured information on an object. This metadata will override the metadata that was passed in payments","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Metadata is useful for storing additional, unstructured information on an object. This metadata will override the metadata that was passed in payments","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"connector_metadata":{"oneOf":[{"type":"object","description":"Some connectors like Apple Pay, Airwallex and Noon might require some additional information, find specific details in the child attributes below.","properties":{"apple_pay":{"oneOf":[{"type":"object","properties":{"session_token_data":{"oneOf":[{"type":"object","required":["certificate","certificate_keys","merchant_identifier","display_name","initiative","payment_processing_details_at","payment_processing_certificate","payment_processing_certificate_key"],"properties":{"payment_processing_certificate":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.payment_processing_certificate","typeLabel":"string"},"payment_processing_certificate_key":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.payment_processing_certificate_key","typeLabel":"string"},"payment_processing_details_at":{"type":"string","enum":["Hyperswitch"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.payment_processing_details_at","typeLabel":"enum\u003cstring>"},"certificate":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.certificate","typeLabel":"string"},"certificate_keys":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.certificate_keys","typeLabel":"string"},"merchant_identifier":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.merchant_identifier","typeLabel":"string"},"display_name":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.display_name","typeLabel":"string"},"initiative":{"type":"string","enum":["web","ios"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.initiative","typeLabel":"enum\u003cstring>"},"initiative_context":{"oneOf":[{"type":"string","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.initiative_context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.initiative_context.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.initiative_context","typeLabel":"string | 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":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.merchant_business_country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.merchant_business_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.merchant_business_country","typeLabel":"enum\u003cstring> | null"},"payment_processing_detail_input_type":{"oneOf":[{"type":"string","description":"Specifies how the Apple Pay payment processing details are supplied.","enum":["raw","link_hierarchical_resource"],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.payment_processing_detail_input_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.payment_processing_detail_input_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.payment_processing_detail_input_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0","typeLabel":"object"},{"type":"object","required":["certificate","certificate_keys","merchant_identifier","display_name","initiative","payment_processing_details_at"],"properties":{"payment_processing_details_at":{"type":"string","enum":["Connector"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.payment_processing_details_at","typeLabel":"enum\u003cstring>"},"certificate":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.certificate","typeLabel":"string"},"certificate_keys":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.certificate_keys","typeLabel":"string"},"merchant_identifier":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.merchant_identifier","typeLabel":"string"},"display_name":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.display_name","typeLabel":"string"},"initiative":{"type":"string","enum":["web","ios"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.initiative","typeLabel":"enum\u003cstring>"},"initiative_context":{"oneOf":[{"type":"string","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.initiative_context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.initiative_context.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.initiative_context","typeLabel":"string | 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":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.merchant_business_country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.merchant_business_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.merchant_business_country","typeLabel":"enum\u003cstring> | null"},"payment_processing_detail_input_type":{"oneOf":[{"type":"string","description":"Specifies how the Apple Pay payment processing details are supplied.","enum":["raw","link_hierarchical_resource"],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.payment_processing_detail_input_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.payment_processing_detail_input_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.payment_processing_detail_input_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.2","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data","typeLabel":"object · object · null"}},"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay","typeLabel":"object | null"},"airwallex":{"oneOf":[{"type":"object","properties":{"payload":{"oneOf":[{"type":"string","description":"payload required by airwallex","uniqueKey":"connector_metadata.oneOf.0.airwallex.oneOf.0.payload.oneOf.0","typeLabel":"string"},{"type":"null","description":"payload required by airwallex","uniqueKey":"connector_metadata.oneOf.0.airwallex.oneOf.0.payload.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.airwallex.oneOf.0.payload","typeLabel":"string | null"}},"uniqueKey":"connector_metadata.oneOf.0.airwallex.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.airwallex.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.airwallex","typeLabel":"object | null"},"noon":{"oneOf":[{"type":"object","properties":{"order_category":{"oneOf":[{"type":"string","description":"Information about the order category that merchant wants to specify at connector level. (e.g. In Noon Payments it can take values like \"pay\", \"food\", or any other custom string set by the merchant in Noon's Dashboard)","uniqueKey":"connector_metadata.oneOf.0.noon.oneOf.0.order_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"Information about the order category that merchant wants to specify at connector level. (e.g. In Noon Payments it can take values like \"pay\", \"food\", or any other custom string set by the merchant in Noon's Dashboard)","uniqueKey":"connector_metadata.oneOf.0.noon.oneOf.0.order_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.noon.oneOf.0.order_category","typeLabel":"string | null"}},"uniqueKey":"connector_metadata.oneOf.0.noon.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.noon.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.noon","typeLabel":"object | null"},"braintree":{"oneOf":[{"type":"object","required":["merchant_account_id","merchant_config_currency"],"properties":{"merchant_account_id":{"type":"string","description":"Information about the merchant_account_id that merchant wants to specify at connector level.","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.braintree.oneOf.0.merchant_account_id","typeLabel":"string"},"merchant_config_currency":{"type":"string","description":"Information about the merchant_config_currency that merchant wants to specify at connector level.","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.braintree.oneOf.0.merchant_config_currency","typeLabel":"string"}},"uniqueKey":"connector_metadata.oneOf.0.braintree.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.braintree.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.braintree","typeLabel":"object | null"},"adyen":{"oneOf":[{"type":"object","required":["testing"],"properties":{"testing":{"type":"object","required":["holder_name"],"properties":{"holder_name":{"type":"string","description":"Holder name to be sent to Adyen for a card payment(CIT) or a generic payment(MIT). This value overrides the values for card.card_holder_name and applies during both CIT and MIT payment transactions.","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.adyen.oneOf.0.testing.holder_name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.adyen.oneOf.0.testing","typeLabel":"object"}},"uniqueKey":"connector_metadata.oneOf.0.adyen.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.adyen.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.adyen","typeLabel":"object | null"},"peachpayments":{"oneOf":[{"type":"object","properties":{"rrn":{"oneOf":[{"type":"string","description":"A numeric reference number supplied by the system retaining the original source information and used to assist in locating that information or a copy thereof.","uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0.rrn.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric reference number supplied by the system retaining the original source information and used to assist in locating that information or a copy thereof.","uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0.rrn.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0.rrn","typeLabel":"string | null"},"card_on_file_transaction_type":{"oneOf":[{"type":"string","enum":["one_off","customer_initiated_transaction","merchant_initiated_mandate","merchant_initiated_transaction"],"uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0.card_on_file_transaction_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0.card_on_file_transaction_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0.card_on_file_transaction_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.peachpayments","typeLabel":"object | null"},"santander":{"oneOf":[{"type":"object","description":"Represents the connector-specific metadata for Santander payments, including boleto data and related rules.","properties":{"boleto":{"oneOf":[{"type":"object","description":"Represents the specific data and rules related to Santander Boleto payments, including discounts, penalties, collection actions, payment constraints, beneficiary details, and document kind.","properties":{"discount_rules":{"oneOf":[{"type":"object","description":"Defines the type of discount applied to a payment, such as whether it's a fixed date discount, a daily calendar discount, or a daily business discount.","required":["tiers"],"properties":{"tiers":{"type":"array","items":{"type":"object","properties":{"amount":{"oneOf":[{"type":"string","description":"The discount value (e.g., \"5.50\").","example":"5.50","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"The discount value (e.g., \"5.50\").","example":"5.50","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].amount","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","description":"The ISO-8601 date until which this discount is valid","example":"2027-12-31","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].end_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ISO-8601 date until which this discount is valid","example":"2027-12-31","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].end_date","typeLabel":"string | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX]","typeLabel":"object"},"description":"A generic vector of discount tiers","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers","typeLabel":"object[]"},"discount_type":{"oneOf":[{"type":"string","description":"Defines the type of discount applied to a payment, such as whether it's a fixed date discount, a daily calendar discount, or a daily business discount.","enum":["standard","fixed_date","daily_calendar","daily_business"],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.discount_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.discount_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.discount_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules","typeLabel":"object | null"},"penalties":{"oneOf":[{"type":"object","description":"Represents the rules for applying discounts to a payment, such as a percentage discount or a fixed amount discount, along with any applicable grace periods.","properties":{"fixed_penalty":{"oneOf":[{"type":"object","description":"Represents the rules for applying discounts to a payment, such as a percentage discount or a fixed amount discount, along with any applicable grace periods.","properties":{"value":{"oneOf":[{"type":"string","description":"The numeric value (as a string to preserve decimal precision)","example":"2.00","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"The numeric value (as a string to preserve decimal precision)","example":"2.00","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.value","typeLabel":"string | null"},"grace_period_days":{"oneOf":[{"type":"integer","format":"int32","description":"Grace period: Days after due date before this applies","example":1,"minimum":0,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.grace_period_days.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Grace period: Days after due date before this applies","example":1,"minimum":0,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.grace_period_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.grace_period_days","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty","typeLabel":"object | null"},"interest":{"oneOf":[{"type":"object","description":"Represents the rules for applying discounts to a payment, such as a percentage discount or a fixed amount discount, along with any applicable grace periods.","properties":{"interest_percentage":{"oneOf":[{"type":"string","description":"Percentage of Juros (Interest). Pattern: ^[0-9]{1,3}\\.[0-9]{2}$","example":"5.00","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0.interest_percentage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Percentage of Juros (Interest). Pattern: ^[0-9]{1,3}\\.[0-9]{2}$","example":"5.00","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0.interest_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0.interest_percentage","typeLabel":"string | null"},"iof_percentage":{"oneOf":[{"type":"string","description":"Percentage of IOF (Financial Operations Tax). Pattern: \\d{3}$\\.\\d{5}\nOnly provided if the agreement is \"Cobra IOF na Barra ou Cadastro\"","example":"32.45325","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0.iof_percentage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Percentage of IOF (Financial Operations Tax). Pattern: \\d{3}$\\.\\d{5}\nOnly provided if the agreement is \"Cobra IOF na Barra ou Cadastro\"","example":"32.45325","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0.iof_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0.iof_percentage","typeLabel":"string | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest","typeLabel":"object | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties","typeLabel":"object | null"},"collection_actions":{"oneOf":[{"type":"object","description":"Represents the legal or administrative actions that may be taken for non-payment, such as protest rules and automatic write-off timelines.","properties":{"legal_protest":{"oneOf":[{"type":"object","required":["protest_type","days_after_due_date"],"properties":{"protest_type":{"type":"string","description":"Defines the type of protest for non-payment, such as whether the count is based on calendar days, business days, or if the protest logic is determined by a pre-signed contract with the bank.","enum":["disabled","calendar_days","business_days","contract_default"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.0.protest_type","typeLabel":"enum\u003cstring>"},"days_after_due_date":{"type":"integer","format":"int32","description":"Number of days after the due date to initiate the protest","example":30,"minimum":0,"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.0.days_after_due_date","typeLabel":"integer\u003cint32>"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.legal_protest","typeLabel":"object | null"},"auto_write_off_days":{"oneOf":[{"type":"integer","format":"int32","description":"Days after which the bill is automatically cancelled/written off","example":60,"minimum":0,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.auto_write_off_days.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Days after which the bill is automatically cancelled/written off","example":60,"minimum":0,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.auto_write_off_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.auto_write_off_days","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions","typeLabel":"object | null"},"payment_constraints":{"oneOf":[{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","required":["type"],"properties":{"type":{"type":"string","enum":["fixed_amount"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.0","typeLabel":"object"},{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","required":["type","details"],"properties":{"type":{"type":"string","enum":["flexible_amount"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.type","typeLabel":"enum\u003cstring>"},"details":{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","properties":{"min_value":{"oneOf":[{"type":"string","description":"Minimum value allowed (e.g., \"10.00\")","example":"38.02","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.min_value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Minimum value allowed (e.g., \"10.00\")","example":"38.02","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.min_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.min_value","typeLabel":"string | null"},"max_value":{"oneOf":[{"type":"string","description":"Maximum value allowed (e.g., \"5000.00\")","example":"38.02","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.max_value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Maximum value allowed (e.g., \"5000.00\")","example":"38.02","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.max_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.max_value","typeLabel":"string | null"},"value_type":{"oneOf":[{"type":"string","description":"Defines how the payment amount is calculated for penalties or discounts, either as a percentage or as a flat amount.","enum":["percentage","flat_amount"],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.value_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.value_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.value_type","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details","typeLabel":"object"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1","typeLabel":"object"},{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","required":["type","details"],"properties":{"type":{"type":"string","enum":["installment"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.type","typeLabel":"enum\u003cstring>"},"details":{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","properties":{"max_partial_payments":{"oneOf":[{"type":"integer","format":"int32","description":"Maximum number of partial payments allowed (Up to 99 for Santander).","example":99,"minimum":0,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details.max_partial_payments.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Maximum number of partial payments allowed (Up to 99 for Santander).","example":99,"minimum":0,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details.max_partial_payments.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details.max_partial_payments","typeLabel":"integer\u003cint32> | null"},"value_type":{"oneOf":[{"type":"string","description":"Defines how the payment amount is calculated for penalties or discounts, either as a percentage or as a flat amount.","enum":["percentage","flat_amount"],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details.value_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details.value_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details.value_type","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details","typeLabel":"object"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.3","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints","typeLabel":"object · object · object · null"},"beneficiary":{"oneOf":[{"type":"object","description":"Represents the end-recipient of a payout or fund transfer.","properties":{"name":{"oneOf":[{"type":"string","description":"The full legal name of the individual or entity receiving the funds.","example":"João da Silva","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full legal name of the individual or entity receiving the funds.","example":"João da Silva","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.name","typeLabel":"string | null"},"document_number":{"oneOf":[{"type":"string","description":"The customer's unique identification number (e.g., Tax ID, SSN, Passport Number).\nUsed by processors to verify the identity of the recipient and prevent fraud.\nLength of the document number depends upon the document_type.\nFor CPF/CNPJ it is typically 11/14 digits long.","example":"9615865832","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.document_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's unique identification number (e.g., Tax ID, SSN, Passport Number).\nUsed by processors to verify the identity of the recipient and prevent fraud.\nLength of the document number depends upon the document_type.\nFor CPF/CNPJ it is typically 11/14 digits long.","example":"9615865832","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.document_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.document_number","typeLabel":"string | null"},"document_type":{"oneOf":[{"type":"string","description":"Represents the type of identification document used for validation.","enum":["cpf","cnpj","psn","other"],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.document_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.document_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.document_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary","typeLabel":"object | null"},"document_kind":{"oneOf":[{"type":"string","enum":["commercial_invoice","service_invoice","promissory_note","rural_promissory_note","receipt","insurance_policy","credit_card_invoice","proposal","deposit_or_funding","cheque","direct_promissory_note","other"],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.document_kind.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.document_kind.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.document_kind","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto","typeLabel":"object | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander","typeLabel":"object | null"},"paypal":{"oneOf":[{"type":"object","description":"PayPal-specific metadata supplied with a payment request.","properties":{"paypal_client_metadata_id":{"oneOf":[{"type":"string","description":"FraudNet session identifier sent in the PAYPAL-CLIENT-METADATA-ID request header.","uniqueKey":"connector_metadata.oneOf.0.paypal.oneOf.0.paypal_client_metadata_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"FraudNet session identifier sent in the PAYPAL-CLIENT-METADATA-ID request header.","uniqueKey":"connector_metadata.oneOf.0.paypal.oneOf.0.paypal_client_metadata_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.paypal.oneOf.0.paypal_client_metadata_id","typeLabel":"string | null"}},"uniqueKey":"connector_metadata.oneOf.0.paypal.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.paypal.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.paypal","typeLabel":"object | null"},"worldpayxml":{"oneOf":[{"type":"object","properties":{"funding_transaction_type":{"oneOf":[{"type":"string","enum":["credit_card_bill_repayment","gift_card_purchase","gift_card_purchase_for_another","non_reloadable_prepaid_card","reloadable_prepaid_card_or_account","gaming_chips_purchase","gaming_stored_value_wallet","gaming_staged_digital_wallet","liquid_and_crypto_assets_purchase","liquid_and_crypto_stored_value_wallet_load","stored_value_digital_wallet_load","stored_value_digital_wallet_load_non_securities","securities_stored_value_digital_wallet_load","securities_staged_digital_wallet_load","single_merchant_wallet_load","debit_card_load","transfer_to_own_debit_account","funds_transfer_me_to_me","account_to_account","back_to_back_p2p_without_wallet","back_to_back_p2p_with_wallet","agent_cash_out","staged_digital_wallet_load","staged_digital_wallet_purchase","back_to_back_card_purchase","payroll_disbursement_funding","business_to_consumer_disbursement","business_to_business_invoice_payment"],"uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0.funding_transaction_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0.funding_transaction_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0.funding_transaction_type","typeLabel":"enum\u003cstring> | null"},"payment_purpose":{"oneOf":[{"type":"string","enum":["family_support","regular_labour_transfers","travel_and_tourism","education","hospitalisation_and_medical_treatment","emergency_need","savings","gifts","other","salary","crowd_lending","crypto_currency","high_risk_securities"],"uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0.payment_purpose.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0.payment_purpose.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0.payment_purpose","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.worldpayxml","typeLabel":"object | null"},"checkout":{"oneOf":[{"type":"object","properties":{"purpose_of_payment":{"oneOf":[{"type":"string","description":"Purpose of Payment. Required for AFT.","example":"wallet top-up","uniqueKey":"connector_metadata.oneOf.0.checkout.oneOf.0.purpose_of_payment.oneOf.0","typeLabel":"string"},{"type":"null","description":"Purpose of Payment. Required for AFT.","example":"wallet top-up","uniqueKey":"connector_metadata.oneOf.0.checkout.oneOf.0.purpose_of_payment.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.checkout.oneOf.0.purpose_of_payment","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"connector_metadata.oneOf.0.checkout.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.checkout.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.checkout","typeLabel":"object | null"},"stripe":{"oneOf":[{"type":"object","properties":{"error_on_requires_action":{"oneOf":[{"type":"boolean","description":"For MIT (merchant-initiated) payments: when true, Stripe fails the payment outright\ninstead of returning a `requires_action` status, since there's no customer present to\ncomplete additional authentication.","uniqueKey":"connector_metadata.oneOf.0.stripe.oneOf.0.error_on_requires_action.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"For MIT (merchant-initiated) payments: when true, Stripe fails the payment outright\ninstead of returning a `requires_action` status, since there's no customer present to\ncomplete additional authentication.","uniqueKey":"connector_metadata.oneOf.0.stripe.oneOf.0.error_on_requires_action.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.stripe.oneOf.0.error_on_requires_action","typeLabel":"boolean | null"}},"uniqueKey":"connector_metadata.oneOf.0.stripe.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.stripe.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.stripe","typeLabel":"object | null"}},"uniqueKey":"connector_metadata.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata","typeLabel":"object | null"},"feature_metadata":{"oneOf":[{"type":"object","description":"additional data that might be required by hyperswitch","properties":{"redirect_response":{"oneOf":[{"type":"object","properties":{"param":{"oneOf":[{"type":"string","uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0.param.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0.param","typeLabel":"string | null"},"json_payload":{"oneOf":[{"type":"object","uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0.json_payload.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0.json_payload.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0.json_payload","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.redirect_response","typeLabel":"object | null"},"search_tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"feature_metadata.oneOf.0.search_tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Additional tags to be used for global search","uniqueKey":"feature_metadata.oneOf.0.search_tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Additional tags to be used for global search","uniqueKey":"feature_metadata.oneOf.0.search_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.search_tags","typeLabel":"string[] | null"},"apple_pay_recurring_details":{"oneOf":[{"type":"object","required":["payment_description","regular_billing","management_url"],"properties":{"payment_description":{"type":"string","description":"A description of the recurring payment that Apple Pay displays to the user in the payment sheet","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.payment_description","typeLabel":"string"},"regular_billing":{"type":"object","required":["label"],"properties":{"label":{"type":"string","description":"The label that Apple Pay displays to the user in the payment sheet with the recurring details","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.label","typeLabel":"string"},"recurring_payment_start_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date of the first payment","example":"2023-09-10T23:59:59Z","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_start_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date of the first payment","example":"2023-09-10T23:59:59Z","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_start_date","typeLabel":"string\u003cdate-time> | null"},"recurring_payment_end_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date of the final payment","example":"2023-09-10T23:59:59Z","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_end_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date of the final payment","example":"2023-09-10T23:59:59Z","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_end_date","typeLabel":"string\u003cdate-time> | null"},"recurring_payment_interval_unit":{"oneOf":[{"type":"string","enum":["year","month","day","hour","minute"],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_interval_unit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_interval_unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_interval_unit","typeLabel":"enum\u003cstring> | null"},"recurring_payment_interval_count":{"oneOf":[{"type":"integer","format":"int32","description":"The number of interval units that make up the total payment interval","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_interval_count.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"The number of interval units that make up the total payment interval","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_interval_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_interval_count","typeLabel":"integer\u003cint32> | null"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing","typeLabel":"object"},"management_url":{"type":"string","description":"A URL to a web page where the user can update or delete the payment method for the recurring payment","example":"https://hyperswitch.io","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.management_url","typeLabel":"string"},"billing_agreement":{"oneOf":[{"type":"string","description":"A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.billing_agreement.oneOf.0","typeLabel":"string"},{"type":"null","description":"A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.billing_agreement.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.billing_agreement","typeLabel":"string | null"}},"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details","typeLabel":"object | null"},"revenue_recovery":{"oneOf":[{"type":"object","required":["total_retry_count","billing_connector_payment_details","payment_method_type","payment_method_subtype","connector","billing_connector_payment_method_details"],"properties":{"total_retry_count":{"type":"integer","format":"int32","description":"Total number of billing connector + recovery retries for a payment intent.","example":"1","minimum":0,"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.total_retry_count","typeLabel":"integer\u003cint32>"},"billing_connector_payment_details":{"type":"object","required":["payment_processor_token","connector_customer_id"],"properties":{"payment_processor_token":{"type":"string","description":"Payment Processor Token to process the Revenue Recovery Payment","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_details.payment_processor_token","typeLabel":"string"},"connector_customer_id":{"type":"string","description":"Billing Connector's Customer Id","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_details.connector_customer_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_details","typeLabel":"object"},"payment_method_type":{"type":"string","description":"Indicates the type of payment method. Eg: 'card', 'wallet', etc.","enum":["card","card_redirect","pay_later","wallet","bank_redirect","bank_transfer","crypto","bank_debit","reward","real_time_payment","upi","voucher","gift_card","open_banking","mobile_payment","network_token"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.payment_method_type","typeLabel":"enum\u003cstring>"},"payment_method_subtype":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eft_debit_order","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","neteller","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","pix_key","pix_emv","pix_qr","pix_automatico_qr","pix_automatico_push","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","wero","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","payshap","payshap_proxy","ted"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.payment_method_subtype","typeLabel":"enum\u003cstring>"},"connector":{"type":"string","enum":["absa_sanlam","authipay","adyenplatform","stripe_billing_test","phonypay","fauxpay","pretendpay","stripe_test","adyen_test","checkout_test","paypal_test","aci","adyen","affirm","airwallex","amazonpay","archipel","authorizedotnet","bambora","bamboraapac","bankofamerica","barclaycard","betterpayment","billwerk","bitpay","bluesnap","blackhawknetwork","calida","boku","braintree","breadpay","cardinal","cashtocode","celero","chargebee","checkbook","checkout","citigate","coinbase","coingate","custombilling","cryptopay","ctp_mastercard","ctp_visa","cybersource","cybersourcedecisionmanager","d24","datatrans","deutschebank","digitalvirgo","dlocal","dwolla","ebanx","ecommpay","envoy","elavon","etisalat","elavon_pg","facilitapay","finix","fiserv","fiservemea","fiservcommercehub","fiuu","flexiti","forte","getnet","gigadat","givepayments","globalpay","globalpayments_heartland","globalpayments_realex","globepay","gocardless","gotyme_sanlam","gpayments","hipay","helcim","hyperpg","hyperswitch_vault","interpayments","inespay","iatapay","ilixium","imerchantsolutions","itaubank","jpmorgan","jpmorgan_orbital","juspay","juspaythreedsserver","klarna","loonio","merchante","mifinity","mollie","moneris","multisafepay","netcetera","nexinets","nexixpay","nmi","nomupay","noon","nordea","novalnet","nuvei","opennode","paybox","paydotcom","payload","payme","paynearme","payone","paypal","paysafe","paystack","paytm","payconex","payu","peachpayments","payjustnow","payjustnowinstore","phonepe","placetopay","powertranz","prophetpay","rapyd","razorpay","recurly","redsys","revolv3","saferpay","santander","shift4","silverflow","square","stax","stripe","stripebilling","taxjar","threedsecureio","tesouro","tokenex","tokenio","trustly","truelayer","trustpay","trustpayments","tsys","tsys_transit","vgs","volt","wellsfargo","wise","worldline","worldpay","worldpayraft","worldpayvantiv","worldpayxml","worldpaymodular","signifyd","nsure","plaid","riskified","sanlam_payshield","xendit","zen","zift","zsl"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.connector","typeLabel":"enum\u003cstring>"},"billing_connector_payment_method_details":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["card"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.type","typeLabel":"enum\u003cstring>"},"value":{"type":"object","required":["card_network"],"properties":{"card_network":{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce","Prop","PrivateLabel","Dinacard","AirPlus","Aurore","EftposAustralia","GeCapital","Uatp"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_network","typeLabel":"enum\u003cstring>"},"card_issuer":{"oneOf":[{"type":"string","description":"Card Issuer","example":"JP MORGAN CHASE","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_issuer.oneOf.0","typeLabel":"string"},{"type":"null","description":"Card Issuer","example":"JP MORGAN CHASE","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_issuer.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_issuer","typeLabel":"string | null"},"card_type":{"oneOf":[{"type":"string","description":"Funding type of the card, `credit` or `debit`, enriched from the card bin","example":"credit","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Funding type of the card, `credit` or `debit`, enriched from the card bin","example":"credit","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_type","typeLabel":"string | null"},"card_issuing_country":{"oneOf":[{"type":"string","description":"Country in which the card was issued, enriched from the card bin","example":"INDIA","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_issuing_country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country in which the card was issued, enriched from the card bin","example":"INDIA","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_issuing_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_issuing_country","typeLabel":"string | null"},"card_isin":{"oneOf":[{"type":"string","description":"Issuer identification number of the card, retained so that any further card details can\nbe looked up from it later","example":"424242","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_isin.oneOf.0","typeLabel":"string"},{"type":"null","description":"Issuer identification number of the card, retained so that any further card details can\nbe looked up from it later","example":"424242","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_isin.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_isin","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value","typeLabel":"object"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details","typeLabel":"object"},"payment_connector_transmission":{"oneOf":[{"type":"string","enum":["ConnectorCallUnsuccessful","ConnectorCallSucceeded"],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.payment_connector_transmission.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.payment_connector_transmission.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.payment_connector_transmission","typeLabel":"enum\u003cstring> | null"},"billing_connector_id":{"oneOf":[{"type":"string","description":"Billing Connector Id to update the invoices. Absent when the transaction is recorded without merchant connector accounts.","example":"mca_1234567890","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Billing Connector Id to update the invoices. Absent when the transaction is recorded without merchant connector accounts.","example":"mca_1234567890","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_id","typeLabel":"string | null"},"active_attempt_payment_connector_id":{"oneOf":[{"type":"string","description":"Payment Connector Id to retry the payments. Absent when the transaction is recorded without merchant connector accounts.","example":"mca_1234567890","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.active_attempt_payment_connector_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Payment Connector Id to retry the payments. Absent when the transaction is recorded without merchant connector accounts.","example":"mca_1234567890","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.active_attempt_payment_connector_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.active_attempt_payment_connector_id","typeLabel":"string | null"},"invoice_next_billing_time":{"oneOf":[{"type":"string","format":"date-time","description":"Invoice Next billing time","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.invoice_next_billing_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Invoice Next billing time","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.invoice_next_billing_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.invoice_next_billing_time","typeLabel":"string\u003cdate-time> | null"},"invoice_billing_started_at_time":{"oneOf":[{"type":"string","format":"date-time","description":"Invoice Next billing time","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.invoice_billing_started_at_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Invoice Next billing time","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.invoice_billing_started_at_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.invoice_billing_started_at_time","typeLabel":"string\u003cdate-time> | null"},"first_payment_attempt_pg_error_code":{"oneOf":[{"type":"string","description":"First Payment Attempt Payment Gateway Error Code","example":"card_declined","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_pg_error_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"First Payment Attempt Payment Gateway Error Code","example":"card_declined","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_pg_error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_pg_error_code","typeLabel":"string | null"},"first_payment_attempt_network_decline_code":{"oneOf":[{"type":"string","description":"First Payment Attempt Network Error Code","example":"05","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_network_decline_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"First Payment Attempt Network Error Code","example":"05","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_network_decline_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_network_decline_code","typeLabel":"string | null"},"first_payment_attempt_network_advice_code":{"oneOf":[{"type":"string","description":"First Payment Attempt Network Advice Code","example":"02","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_network_advice_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"First Payment Attempt Network Advice Code","example":"02","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_network_advice_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_network_advice_code","typeLabel":"string | null"},"revenue_recovery_ab_routing":{"oneOf":[{"type":"string","description":"The retry implementations available within the `Smart` arm of revenue recovery.","enum":["adaptive_retry","hybrid_adaptive_retry","systematic_k_max_at_softmax","systematic_k_max_at_score"],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.revenue_recovery_ab_routing.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.revenue_recovery_ab_routing.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.revenue_recovery_ab_routing","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery","typeLabel":"object | null"},"pix_additional_details":{"oneOf":[{"type":"object","required":["immediate"],"properties":{"immediate":{"type":"object","required":["time"],"properties":{"time":{"type":"integer","format":"int32","description":"Expiration time in seconds","minimum":0,"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.time","typeLabel":"integer\u003cint32>"},"pix_key":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["cpf"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.0.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["cnpj"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.2.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.2","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.3.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.3.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["evp_token"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.4.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.4.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.4","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.5","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key","typeLabel":"object · object · object · object · object · null"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate","typeLabel":"object"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0","typeLabel":"object"},{"type":"object","required":["scheduled"],"properties":{"scheduled":{"type":"object","required":["date"],"properties":{"date":{"type":"string","description":"Expiration time in terms of date, format: YYYY-MM-DD","example":"2026-07-08","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.date","typeLabel":"string"},"validity_after_expiration":{"oneOf":[{"type":"integer","format":"int32","description":"Days after expiration date for which the QR code remains valid","example":10,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.validity_after_expiration.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Days after expiration date for which the QR code remains valid","example":10,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.validity_after_expiration.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.validity_after_expiration","typeLabel":"integer\u003cint32> | null"},"pix_key":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["cpf"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.0.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["cnpj"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.2.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.2","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.3.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.3.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["evp_token"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.4.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.4.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.4","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.5","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key","typeLabel":"object · object · object · object · object · null"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled","typeLabel":"object"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.2","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details","typeLabel":"object · object · null"},"boleto_additional_details":{"oneOf":[{"type":"object","properties":{"due_date":{"oneOf":[{"type":"string","description":"Due Date for the Boleto","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.due_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Due Date for the Boleto","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.due_date","typeLabel":"string | null"},"document_kind":{"oneOf":[{"type":"string","enum":["commercial_invoice","service_invoice","promissory_note","rural_promissory_note","receipt","insurance_policy","credit_card_invoice","proposal","deposit_or_funding","cheque","direct_promissory_note","other"],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.document_kind.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.document_kind.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.document_kind","typeLabel":"enum\u003cstring> | null"},"payment_type":{"oneOf":[{"type":"string","enum":["fixed_amount","flexible_amount","installment"],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_type","typeLabel":"enum\u003cstring> | null"},"covenant_code":{"oneOf":[{"type":"string","example":"3568253","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.covenant_code.oneOf.0","typeLabel":"string"},{"type":"null","example":"3568253","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.covenant_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.covenant_code","typeLabel":"string | null"},"pix_key":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["cpf"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.0.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["cnpj"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.2.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.2","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.3.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.3.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["evp_token"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.4.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.4.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.4","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.5","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key","typeLabel":"object · object · object · object · object · null"},"discount_rules":{"oneOf":[{"type":"object","description":"Defines the type of discount applied to a payment, such as whether it's a fixed date discount, a daily calendar discount, or a daily business discount.","required":["tiers"],"properties":{"tiers":{"type":"array","items":{"type":"object","properties":{"amount":{"oneOf":[{"type":"string","description":"The discount value (e.g., \"5.50\").","example":"5.50","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"The discount value (e.g., \"5.50\").","example":"5.50","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].amount","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","description":"The ISO-8601 date until which this discount is valid","example":"2027-12-31","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].end_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ISO-8601 date until which this discount is valid","example":"2027-12-31","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].end_date","typeLabel":"string | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX]","typeLabel":"object"},"description":"A generic vector of discount tiers","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers","typeLabel":"object[]"},"discount_type":{"oneOf":[{"type":"string","description":"Defines the type of discount applied to a payment, such as whether it's a fixed date discount, a daily calendar discount, or a daily business discount.","enum":["standard","fixed_date","daily_calendar","daily_business"],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.discount_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.discount_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.discount_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules","typeLabel":"object | null"},"penalties":{"oneOf":[{"type":"object","description":"Represents the rules for applying discounts to a payment, such as a percentage discount or a fixed amount discount, along with any applicable grace periods.","properties":{"fixed_penalty":{"oneOf":[{"type":"object","description":"Represents the rules for applying discounts to a payment, such as a percentage discount or a fixed amount discount, along with any applicable grace periods.","properties":{"value":{"oneOf":[{"type":"string","description":"The numeric value (as a string to preserve decimal precision)","example":"2.00","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"The numeric value (as a string to preserve decimal precision)","example":"2.00","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.value","typeLabel":"string | null"},"grace_period_days":{"oneOf":[{"type":"integer","format":"int32","description":"Grace period: Days after due date before this applies","example":1,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.grace_period_days.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Grace period: Days after due date before this applies","example":1,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.grace_period_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.grace_period_days","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty","typeLabel":"object | null"},"interest":{"oneOf":[{"type":"object","description":"Represents the rules for applying discounts to a payment, such as a percentage discount or a fixed amount discount, along with any applicable grace periods.","properties":{"interest_percentage":{"oneOf":[{"type":"string","description":"Percentage of Juros (Interest). Pattern: ^[0-9]{1,3}\\.[0-9]{2}$","example":"5.00","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0.interest_percentage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Percentage of Juros (Interest). Pattern: ^[0-9]{1,3}\\.[0-9]{2}$","example":"5.00","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0.interest_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0.interest_percentage","typeLabel":"string | null"},"iof_percentage":{"oneOf":[{"type":"string","description":"Percentage of IOF (Financial Operations Tax). Pattern: \\d{3}$\\.\\d{5}\nOnly provided if the agreement is \"Cobra IOF na Barra ou Cadastro\"","example":"32.45325","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0.iof_percentage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Percentage of IOF (Financial Operations Tax). Pattern: \\d{3}$\\.\\d{5}\nOnly provided if the agreement is \"Cobra IOF na Barra ou Cadastro\"","example":"32.45325","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0.iof_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0.iof_percentage","typeLabel":"string | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties","typeLabel":"object | null"},"collection_actions":{"oneOf":[{"type":"object","description":"Represents the legal or administrative actions that may be taken for non-payment, such as protest rules and automatic write-off timelines.","properties":{"legal_protest":{"oneOf":[{"type":"object","required":["protest_type","days_after_due_date"],"properties":{"protest_type":{"type":"string","description":"Defines the type of protest for non-payment, such as whether the count is based on calendar days, business days, or if the protest logic is determined by a pre-signed contract with the bank.","enum":["disabled","calendar_days","business_days","contract_default"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.0.protest_type","typeLabel":"enum\u003cstring>"},"days_after_due_date":{"type":"integer","format":"int32","description":"Number of days after the due date to initiate the protest","example":30,"minimum":0,"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.0.days_after_due_date","typeLabel":"integer\u003cint32>"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.legal_protest","typeLabel":"object | null"},"auto_write_off_days":{"oneOf":[{"type":"integer","format":"int32","description":"Days after which the bill is automatically cancelled/written off","example":60,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.auto_write_off_days.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Days after which the bill is automatically cancelled/written off","example":60,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.auto_write_off_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.auto_write_off_days","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions","typeLabel":"object | null"},"payment_constraints":{"oneOf":[{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","required":["type"],"properties":{"type":{"type":"string","enum":["fixed_amount"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.0","typeLabel":"object"},{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","required":["type","details"],"properties":{"type":{"type":"string","enum":["flexible_amount"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.type","typeLabel":"enum\u003cstring>"},"details":{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","properties":{"min_value":{"oneOf":[{"type":"string","description":"Minimum value allowed (e.g., \"10.00\")","example":"38.02","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.min_value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Minimum value allowed (e.g., \"10.00\")","example":"38.02","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.min_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.min_value","typeLabel":"string | null"},"max_value":{"oneOf":[{"type":"string","description":"Maximum value allowed (e.g., \"5000.00\")","example":"38.02","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.max_value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Maximum value allowed (e.g., \"5000.00\")","example":"38.02","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.max_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.max_value","typeLabel":"string | null"},"value_type":{"oneOf":[{"type":"string","description":"Defines how the payment amount is calculated for penalties or discounts, either as a percentage or as a flat amount.","enum":["percentage","flat_amount"],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.value_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.value_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.value_type","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details","typeLabel":"object"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1","typeLabel":"object"},{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","required":["type","details"],"properties":{"type":{"type":"string","enum":["installment"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.type","typeLabel":"enum\u003cstring>"},"details":{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","properties":{"max_partial_payments":{"oneOf":[{"type":"integer","format":"int32","description":"Maximum number of partial payments allowed (Up to 99 for Santander).","example":99,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details.max_partial_payments.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Maximum number of partial payments allowed (Up to 99 for Santander).","example":99,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details.max_partial_payments.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details.max_partial_payments","typeLabel":"integer\u003cint32> | null"},"value_type":{"oneOf":[{"type":"string","description":"Defines how the payment amount is calculated for penalties or discounts, either as a percentage or as a flat amount.","enum":["percentage","flat_amount"],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details.value_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details.value_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details.value_type","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details","typeLabel":"object"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.3","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints","typeLabel":"object · object · object · null"},"beneficiary":{"oneOf":[{"type":"object","description":"Represents the end-recipient of a payout or fund transfer.","properties":{"name":{"oneOf":[{"type":"string","description":"The full legal name of the individual or entity receiving the funds.","example":"João da Silva","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full legal name of the individual or entity receiving the funds.","example":"João da Silva","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.name","typeLabel":"string | null"},"document_number":{"oneOf":[{"type":"string","description":"The customer's unique identification number (e.g., Tax ID, SSN, Passport Number).\nUsed by processors to verify the identity of the recipient and prevent fraud.\nLength of the document number depends upon the document_type.\nFor CPF/CNPJ it is typically 11/14 digits long.","example":"9615865832","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.document_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's unique identification number (e.g., Tax ID, SSN, Passport Number).\nUsed by processors to verify the identity of the recipient and prevent fraud.\nLength of the document number depends upon the document_type.\nFor CPF/CNPJ it is typically 11/14 digits long.","example":"9615865832","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.document_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.document_number","typeLabel":"string | null"},"document_type":{"oneOf":[{"type":"string","description":"Represents the type of identification document used for validation.","enum":["cpf","cnpj","psn","other"],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.document_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.document_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.document_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details","typeLabel":"object | null"},"pix_automatico_additional_details":{"oneOf":[{"type":"object","description":"Represents the specific data for Santander Pix Automatico (recurring PIX payments)\nSplit into CIT (Customer Initiated Transaction) and MIT (Merchant Initiated Transaction) variants","required":["type","time"],"properties":{"time":{"type":"integer","format":"int32","description":"Time in seconds until which the push notification is valid","example":3600,"minimum":0,"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.time","typeLabel":"integer\u003cint32>"},"type":{"type":"string","enum":["pix_automatico_push"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.type","typeLabel":"enum\u003cstring>"},"retry_policy":{"oneOf":[{"type":"boolean","description":"Enable retry policy for failed payments (maps to PERMITE_3R_7D if true)","example":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.retry_policy.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable retry policy for failed payments (maps to PERMITE_3R_7D if true)","example":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.retry_policy.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.retry_policy","typeLabel":"boolean | null"},"mandate_details":{"oneOf":[{"type":"object","properties":{"fixed_recurring_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Fixed amount for each recurring charge in minor units (e.g., cents). If not provided, the mandate will allow variable amounts.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.fixed_recurring_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Fixed amount for each recurring charge in minor units (e.g., cents). If not provided, the mandate will allow variable amounts.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.fixed_recurring_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.fixed_recurring_amount","typeLabel":"integer\u003cint64> | null"},"min_recurring_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Minimum amount for each recurring charge in minor units (e.g., cents). If not provided, there will be no minimum limit on the amount.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.min_recurring_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Minimum amount for each recurring charge in minor units (e.g., cents). If not provided, there will be no minimum limit on the amount.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.min_recurring_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.min_recurring_amount","typeLabel":"integer\u003cint64> | null"},"start_date":{"oneOf":[{"type":"string","description":"Start date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid immediately.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.start_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Start date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid immediately.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.start_date","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","description":"End date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid indefinitely.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.end_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"End date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid indefinitely.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.end_date","typeLabel":"string | null"},"periodicity":{"oneOf":[{"type":"string","enum":["weekly","monthly","quarterly","semiannually","annually"],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.periodicity.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.periodicity.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.periodicity","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0","typeLabel":"object"},{"type":"object","description":"Represents the specific data for Santander Pix Automatico (recurring PIX payments)\nSplit into CIT (Customer Initiated Transaction) and MIT (Merchant Initiated Transaction) variants","required":["type"],"properties":{"type":{"type":"string","enum":["pix_automatico_qr"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.type","typeLabel":"enum\u003cstring>"},"retry_policy":{"oneOf":[{"type":"boolean","description":"Enable retry policy for failed payments (maps to PERMITE_3R_7D if true)","example":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.retry_policy.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable retry policy for failed payments (maps to PERMITE_3R_7D if true)","example":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.retry_policy.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.retry_policy","typeLabel":"boolean | null"},"mandate_details":{"oneOf":[{"type":"object","properties":{"fixed_recurring_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Fixed amount for each recurring charge in minor units (e.g., cents). If not provided, the mandate will allow variable amounts.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.fixed_recurring_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Fixed amount for each recurring charge in minor units (e.g., cents). If not provided, the mandate will allow variable amounts.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.fixed_recurring_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.fixed_recurring_amount","typeLabel":"integer\u003cint64> | null"},"min_recurring_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Minimum amount for each recurring charge in minor units (e.g., cents). If not provided, there will be no minimum limit on the amount.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.min_recurring_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Minimum amount for each recurring charge in minor units (e.g., cents). If not provided, there will be no minimum limit on the amount.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.min_recurring_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.min_recurring_amount","typeLabel":"integer\u003cint64> | null"},"start_date":{"oneOf":[{"type":"string","description":"Start date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid immediately.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.start_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Start date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid immediately.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.start_date","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","description":"End date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid indefinitely.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.end_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"End date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid indefinitely.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.end_date","typeLabel":"string | null"},"periodicity":{"oneOf":[{"type":"string","enum":["weekly","monthly","quarterly","semiannually","annually"],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.periodicity.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.periodicity.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.periodicity","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1","typeLabel":"object"},{"type":"object","description":"Represents the specific data for Santander Pix Automatico (recurring PIX payments)\nSplit into CIT (Customer Initiated Transaction) and MIT (Merchant Initiated Transaction) variants","required":["type"],"properties":{"type":{"type":"string","enum":["pix_automatico_mit"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.type","typeLabel":"enum\u003cstring>"},"receiver_details":{"oneOf":[{"type":"object","description":"Represents the receiver details for Santander Pix Automatico recurring charges","properties":{"branch_code":{"oneOf":[{"type":"string","description":"Branch code (agencia) of the receiver's bank account","example":"0001","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.branch_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Branch code (agencia) of the receiver's bank account","example":"0001","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.branch_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.branch_code","typeLabel":"string | null"},"account_number":{"oneOf":[{"type":"string","description":"Account number (conta) of the receiver","example":"130333323","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.account_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Account number (conta) of the receiver","example":"130333323","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.account_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.account_number","typeLabel":"string | null"},"account_type":{"oneOf":[{"type":"string","description":"Account type for Santander Pix Automatico recurring charges","enum":["current","savings","payment"],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.account_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.account_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.account_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details","typeLabel":"object | null"},"mandate_execution_date":{"oneOf":[{"type":"string","description":"Execution date for the mandate charge (maps to data_de_vencimento). Format: YYYY-MM-DD.\nIf not provided, defaults to current date + 1 day.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.mandate_execution_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Execution date for the mandate charge (maps to data_de_vencimento). Format: YYYY-MM-DD.\nIf not provided, defaults to current date + 1 day.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.mandate_execution_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.mandate_execution_date","typeLabel":"string | null"},"auto_adjust_date":{"oneOf":[{"type":"boolean","description":"Whether to automatically adjust the due date to the next business day if it falls on a non-business day.\nMaps to ajuste_dia_util in Santander API. Defaults to true if not provided.","example":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.auto_adjust_date.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether to automatically adjust the due date to the next business day if it falls on a non-business day.\nMaps to ajuste_dia_util in Santander API. Defaults to true if not provided.","example":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.auto_adjust_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.auto_adjust_date","typeLabel":"boolean | null"}},"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.3","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details","typeLabel":"object · object · object · null"},"finix_additional_details":{"oneOf":[{"type":"object","properties":{"fraud_session_id":{"oneOf":[{"type":"string","description":"The fraud session ID used for Finix fraud detection","example":"1234567890abcdef","uniqueKey":"feature_metadata.oneOf.0.finix_additional_details.oneOf.0.fraud_session_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The fraud session ID used for Finix fraud detection","example":"1234567890abcdef","uniqueKey":"feature_metadata.oneOf.0.finix_additional_details.oneOf.0.fraud_session_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.finix_additional_details.oneOf.0.fraud_session_id","typeLabel":"string | null"}},"uniqueKey":"feature_metadata.oneOf.0.finix_additional_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.finix_additional_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.finix_additional_details","typeLabel":"object | null"},"multi_currency_processing":{"oneOf":[{"type":"object","description":"Datatrans multi-currency processing (multi-currency processing) details supplied by the merchant.\n\n`amount`/`currency` here describe the **merchant settlement leg** — what Planet pays out to\nthe merchant. The payment's own `amount`/`currency` remain the **customer-facing leg**, i.e.\nwhat the shopper saw at checkout and is charged. Hyperswitch never recomputes either leg; the\nmerchant is the source of truth for both.","required":["currency","amount"],"properties":{"currency":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","format":"int64","description":"The merchant settlement amount, expressed in `currency`. The merchant converts the\ncustomer-facing amount itself and supplies the result here.","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.amount","typeLabel":"integer\u003cint64>"},"conversion_rate":{"oneOf":[{"type":"number","format":"double","description":"Conversion rate received from the currency rates endpoint. Required for dynamic multi-currency processing.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_rate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Conversion rate received from the currency rates endpoint. Required for dynamic multi-currency processing.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_rate","typeLabel":"number\u003cdouble> | null"},"date":{"oneOf":[{"type":"string","format":"date-time","description":"Transaction datetime received from the currency rates endpoint.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Transaction datetime received from the currency rates endpoint.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.date","typeLabel":"string\u003cdate-time> | null"},"processing_reference_id":{"oneOf":[{"type":"string","description":"Processing reference received from the currency rates endpoint.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.processing_reference_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Processing reference received from the currency rates endpoint.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.processing_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.processing_reference_id","typeLabel":"string | null"},"user_id":{"oneOf":[{"type":"string","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.user_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.user_id","typeLabel":"string | null"},"conversion_provider":{"oneOf":[{"type":"string","description":"The provider for multi-currency processing.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"The provider for multi-currency processing.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_provider","typeLabel":"string | null"},"conversion_reason_code":{"oneOf":[{"type":"string","description":"Reason indicator received from the acquirer.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_reason_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reason indicator received from the acquirer.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_reason_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_reason_code","typeLabel":"string | null"}},"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata","typeLabel":"object | 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://hyperswitch.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","eft_debit_order","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","neteller","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","pix_key","pix_emv","pix_qr","pix_automatico_qr","pix_automatico_push","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","wero","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","payshap","payshap_proxy","ted"],"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"},"show_merchant_name":{"oneOf":[{"type":"boolean","description":"Flag to display the merchant name in the payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.show_merchant_name.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Flag to display the merchant name in the payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.show_merchant_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.show_merchant_name","typeLabel":"boolean | null"},"payment_methods_separator_text":{"oneOf":[{"type":"string","description":"Custom text for the separator shown between wallet and card payment method sections","example":"Or pay with","maxLength":64,"uniqueKey":"payment_link_config.oneOf.0.payment_methods_separator_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom text for the separator shown between wallet and card payment method sections","example":"Or pay with","maxLength":64,"uniqueKey":"payment_link_config.oneOf.0.payment_methods_separator_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_methods_separator_text","typeLabel":"string | null"},"redirect_delay_seconds":{"oneOf":[{"type":"integer","format":"int32","description":"Duration in seconds before the status page auto-redirects to the return URL.\nSet to 0 to disable auto-redirect. Maximum value is 900 seconds. Defaults to 5 seconds.","example":10,"maximum":900,"minimum":0,"uniqueKey":"payment_link_config.oneOf.0.redirect_delay_seconds.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Duration in seconds before the status page auto-redirects to the return URL.\nSet to 0 to disable auto-redirect. Maximum value is 900 seconds. Defaults to 5 seconds.","example":10,"maximum":900,"minimum":0,"uniqueKey":"payment_link_config.oneOf.0.redirect_delay_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.redirect_delay_seconds","typeLabel":"integer\u003cint32> | 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"},"request_incremental_authorization":{"oneOf":[{"type":"string","enum":["true","false","default"],"uniqueKey":"request_incremental_authorization.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"request_incremental_authorization.oneOf.1","typeLabel":"null"}],"uniqueKey":"request_incremental_authorization","typeLabel":"enum\u003cstring> | null"},"session_expiry":{"oneOf":[{"type":"integer","format":"int32","description":"Will be used to expire client secret after certain amount of time to be supplied in seconds, if not sent it will be taken from profile config\n(900) for 15 mins","example":900,"minimum":0,"uniqueKey":"session_expiry.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Will be used to expire client secret after certain amount of time to be supplied in seconds, if not sent it will be taken from profile config\n(900) for 15 mins","example":900,"minimum":0,"uniqueKey":"session_expiry.oneOf.1","typeLabel":"null"}],"uniqueKey":"session_expiry","typeLabel":"integer\u003cint32> | null"},"frm_metadata":{"oneOf":[{"type":"object","description":"Additional data related to some frm(Fraud Risk Management) connectors","uniqueKey":"frm_metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional data related to some frm(Fraud Risk Management) connectors","uniqueKey":"frm_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"frm_metadata","typeLabel":"object | null"},"request_external_three_ds_authentication":{"oneOf":[{"type":"string","description":"Whether 3ds authentication is requested or not","enum":["Enable","Skip"],"uniqueKey":"request_external_three_ds_authentication.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"request_external_three_ds_authentication.oneOf.1","typeLabel":"null"}],"uniqueKey":"request_external_three_ds_authentication","typeLabel":"enum\u003cstring> | null"},"set_active_attempt_id":{"oneOf":[{"type":"object","description":"Whether active attempt is to be set/unset/left alone","required":["Set"],"properties":{"Set":{"oneOf":[{"type":"string","description":"Request to set the active attempt id","isRequired":true,"uniqueKey":"set_active_attempt_id.oneOf.0.Set.oneOf.0","typeLabel":"string"},{"type":"null","description":"Request to set the active attempt id","isRequired":true,"uniqueKey":"set_active_attempt_id.oneOf.0.Set.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"set_active_attempt_id.oneOf.0.Set","typeLabel":"string | null"}},"uniqueKey":"set_active_attempt_id.oneOf.0","typeLabel":"object"},{"type":"string","description":"Whether active attempt is to be set/unset/left alone","enum":["Unset"],"uniqueKey":"set_active_attempt_id.oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Whether active attempt is to be set/unset/left alone","enum":["NoAction"],"uniqueKey":"set_active_attempt_id.oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"set_active_attempt_id.oneOf.3","typeLabel":"null"}],"uniqueKey":"set_active_attempt_id","typeLabel":"object · enum\u003cstring> · enum\u003cstring> · null"},"enable_partial_authorization":{"oneOf":[{"type":"boolean","description":"Allow partial authorization for this payment","default":false,"uniqueKey":"enable_partial_authorization.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Allow partial authorization for this payment","default":false,"uniqueKey":"enable_partial_authorization.oneOf.1","typeLabel":"null"}],"uniqueKey":"enable_partial_authorization","typeLabel":"boolean | null"},"is_account_funded_transaction":{"oneOf":[{"type":"boolean","description":"Indicates whether this payment is an account funded transaction.","example":true,"uniqueKey":"is_account_funded_transaction.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether this payment is an account funded transaction.","example":true,"uniqueKey":"is_account_funded_transaction.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_account_funded_transaction","typeLabel":"boolean | null"},"recipient_details":{"oneOf":[{"type":"object","description":"Details of the party receiving the funds in an account funded transaction.","properties":{"account":{"oneOf":[{"type":"object","description":"The account that receives the funds in an account funded transaction.","required":["type","iban","bank_account_type"],"properties":{"iban":{"type":"string","description":"The recipient's IBAN.","example":"GB29NWBK70361331946864","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.0.iban","typeLabel":"string"},"bank_account_type":{"type":"string","enum":["iban"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.0.bank_account_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["bank_account"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.0","typeLabel":"object"},{"type":"object","description":"The account that receives the funds in an account funded transaction.","required":["type","account_number","routing_number","bank_account_type"],"properties":{"account_number":{"type":"string","description":"The recipient's bank account number.","example":"000123456789","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.1.account_number","typeLabel":"string"},"routing_number":{"type":"string","description":"The routing number of the recipient's bank.","example":"110000000","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.1.routing_number","typeLabel":"string"},"bank_account_type":{"type":"string","enum":["routing_number"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.1.bank_account_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["bank_account"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.1","typeLabel":"object"},{"type":"object","description":"The account that receives the funds in an account funded transaction.","required":["type","account_number","bic","bank_account_type"],"properties":{"account_number":{"type":"string","description":"The recipient's bank account number.","example":"09875432","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.2.account_number","typeLabel":"string"},"bic":{"type":"string","description":"The Bank Identification Code of the recipient's bank.","example":"HBUKGB4B","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.2.bic","typeLabel":"string"},"bank_account_type":{"type":"string","enum":["bic"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.2.bank_account_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["bank_account"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.2","typeLabel":"object"},{"type":"object","description":"The account that receives the funds in an account funded transaction.","required":["type","account_number","bank_account_type"],"properties":{"account_number":{"type":"string","description":"The recipient's bank account number.","example":"000123456789","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.3.account_number","typeLabel":"string"},"bank_account_type":{"type":"string","enum":["account_number"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.3.bank_account_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["bank_account"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.3.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.3","typeLabel":"object"},{"type":"object","description":"The account that receives the funds in an account funded transaction.","required":["type","card_isin","last4","bank_account_type"],"properties":{"card_isin":{"type":"string","description":"The first six digits of the recipient's PAN.","example":"411111","maxLength":6,"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.4.card_isin","typeLabel":"string"},"last4":{"type":"string","description":"The last four digits of the recipient's PAN.","example":"1111","maxLength":4,"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.4.last4","typeLabel":"string"},"bank_account_type":{"type":"string","enum":["truncated_pan"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.4.bank_account_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["bank_account"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.4.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.4","typeLabel":"object"},{"type":"object","description":"The account that receives the funds in an account funded transaction.","required":["card_number","type"],"properties":{"card_number":{"type":"string","description":"The recipient's card number.","example":"4111111111111111","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.5.card_number","typeLabel":"string"},"type":{"type":"string","enum":["card"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.5.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.5","typeLabel":"object"},{"type":"object","description":"The account that receives the funds in an account funded transaction.","required":["wallet_id","type"],"properties":{"wallet_id":{"type":"string","description":"The identifier of the recipient's wallet.","example":"wallet_8891","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.6.wallet_id","typeLabel":"string"},"type":{"type":"string","enum":["wallet"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.6.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.6","typeLabel":"object"},{"type":"object","description":"The account that receives the funds in an account funded transaction.","required":["email","type"],"properties":{"email":{"type":"string","description":"The email address that identifies the recipient's account.","example":"jane.doe@example.com","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.7.email","typeLabel":"string"},"type":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.7.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.7","typeLabel":"object"},{"type":"object","description":"The account that receives the funds in an account funded transaction.","required":["phone_number","type"],"properties":{"phone_number":{"type":"string","description":"The phone number that identifies the recipient's account.","example":"9123456789","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.8.phone_number","typeLabel":"string"},"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.8.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.8","typeLabel":"object"},{"type":"object","description":"The account that receives the funds in an account funded transaction.","required":["social_network_id","type"],"properties":{"social_network_id":{"type":"string","description":"The social network identifier of the recipient.","example":"jane.doe","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.9.social_network_id","typeLabel":"string"},"type":{"type":"string","enum":["social_network"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.9.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.9","typeLabel":"object"},{"type":"null","uniqueKey":"recipient_details.oneOf.0.account.oneOf.10","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.account","typeLabel":"object · object · object · object · object · object · object · object · object · object · null"},"phone_number":{"oneOf":[{"type":"string","description":"The recipient's phone number.","example":"9123456789","maxLength":20,"uniqueKey":"recipient_details.oneOf.0.phone_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The recipient's phone number.","example":"9123456789","maxLength":20,"uniqueKey":"recipient_details.oneOf.0.phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.phone_number","typeLabel":"string | null"},"tax_id":{"oneOf":[{"type":"string","description":"The recipient's tax identifier. Some connectors require this for recipients in Brazil\n(CPF or CNPJ) and Argentina.","example":"162.152.541-42","maxLength":25,"uniqueKey":"recipient_details.oneOf.0.tax_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The recipient's tax identifier. Some connectors require this for recipients in Brazil\n(CPF or CNPJ) and Argentina.","example":"162.152.541-42","maxLength":25,"uniqueKey":"recipient_details.oneOf.0.tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.tax_id","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","description":"Address details","properties":{"city":{"oneOf":[{"type":"string","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.country","typeLabel":"enum\u003cstring> | null"},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"line3":{"oneOf":[{"type":"string","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line3","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The address state","example":"New York","uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address state","example":"New York","uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.last_name","typeLabel":"string | null"},"origin_zip":{"oneOf":[{"type":"string","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.origin_zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.origin_zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.origin_zip","typeLabel":"string | null"}},"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"recipient_details.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address","typeLabel":"object | null"}},"uniqueKey":"recipient_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"recipient_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details","typeLabel":"object | null"},"enable_avs_check":{"oneOf":[{"type":"boolean","description":"Request address verification using the billing address for supported card payments.\nOmit this field on updates or confirmation to preserve the existing setting.","default":false,"example":true,"uniqueKey":"enable_avs_check.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Request address verification using the billing address for supported card payments.\nOmit this field on updates or confirmation to preserve the existing setting.","default":false,"example":true,"uniqueKey":"enable_avs_check.oneOf.1","typeLabel":"null"}],"uniqueKey":"enable_avs_check","typeLabel":"boolean | null"},"enable_account_name_verification":{"oneOf":[{"type":"boolean","description":"Request account name verification for supported payments.","default":false,"example":true,"uniqueKey":"enable_account_name_verification.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Request account name verification for supported payments.","default":false,"example":true,"uniqueKey":"enable_account_name_verification.oneOf.1","typeLabel":"null"}],"uniqueKey":"enable_account_name_verification","typeLabel":"boolean | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Update a payment intent with minimal fields":{"title":"Update a payment intent with minimal fields","value":{"amount_details":{"currency":"USD","order_amount":6540}}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"358616fa-c17b-432e-a2f6-7d52af0e47c0":{"description":"Payment Intent Updated","content":{"application/json":{"schema":{"type":"object","required":["id","status","amount_details","client_secret","profile_id","capture_method","customer_id","customer_present","setup_future_usage","apply_mit_exemption","payment_link_enabled","request_incremental_authorization","split_txns_enabled","expires_on","request_external_three_ds_authentication","payment_type"],"properties":{"id":{"type":"string","description":"Global Payment Id for the payment","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","description":"Represents the overall status of a payment intent.\nThe status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).","enum":["succeeded","failed","cancelled","cancelled_post_capture","processing","requires_customer_action","requires_merchant_action","requires_payment_method","requires_confirmation","requires_capture","partially_captured","partially_captured_and_capturable","partially_authorized_and_requires_capture","partially_captured_and_processing","conflicted","expired","review"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"amount_details":{"type":"object","required":["order_amount","currency","external_tax_calculation","surcharge_calculation"],"properties":{"order_amount":{"type":"integer","format":"int64","description":"The payment amount. Amount for the payment in the lowest denomination of the currency, (i.e) in cents for USD denomination, in yen for JPY denomination etc. E.g., Pass 100 to charge $1.00 and 1 for 1¥ since ¥ is a zero-decimal currency. Read more about [the Decimal and Non-Decimal Currencies](https://github.com/juspay/hyperswitch/wiki/Decimal-and-Non%E2%80%90Decimal-Currencies)","example":6540,"minimum":0,"isRequired":true,"uniqueKey":"amount_details.order_amount","typeLabel":"integer\u003cint64>"},"currency":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"isRequired":true,"uniqueKey":"amount_details.currency","typeLabel":"enum\u003cstring>"},"external_tax_calculation":{"type":"string","enum":["skip","calculate"],"isRequired":true,"uniqueKey":"amount_details.external_tax_calculation","typeLabel":"enum\u003cstring>"},"surcharge_calculation":{"type":"string","enum":["skip","calculate"],"isRequired":true,"uniqueKey":"amount_details.surcharge_calculation","typeLabel":"enum\u003cstring>"},"shipping_cost":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64","uniqueKey":"amount_details.shipping_cost.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","uniqueKey":"amount_details.shipping_cost.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.shipping_cost","typeLabel":"integer\u003cint64> | null"},"order_tax_amount":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64","uniqueKey":"amount_details.order_tax_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","uniqueKey":"amount_details.order_tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.order_tax_amount","typeLabel":"integer\u003cint64> | null"},"surcharge_amount":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64","uniqueKey":"amount_details.surcharge_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","uniqueKey":"amount_details.surcharge_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.surcharge_amount","typeLabel":"integer\u003cint64> | null"},"tax_on_surcharge":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64","uniqueKey":"amount_details.tax_on_surcharge.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","uniqueKey":"amount_details.tax_on_surcharge.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.tax_on_surcharge","typeLabel":"integer\u003cint64> | null"},"amount_captured":{"oneOf":[{"type":"integer","description":"This Unit struct represents MinorUnit in which core amount works","format":"int64","uniqueKey":"amount_details.amount_captured.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","uniqueKey":"amount_details.amount_captured.oneOf.1","typeLabel":"null"}],"uniqueKey":"amount_details.amount_captured","typeLabel":"integer\u003cint64> | null"}},"isRequired":true,"uniqueKey":"amount_details","typeLabel":"object"},"client_secret":{"type":"string","description":"It's a token used for client side verification.","example":"cs_0195b34da95d75239c6a4bf514458896","isRequired":true,"uniqueKey":"client_secret","typeLabel":"string"},"profile_id":{"type":"string","description":"The identifier for the profile. This is inferred from the `x-profile-id` header","isRequired":true,"uniqueKey":"profile_id","typeLabel":"string"},"capture_method":{"type":"string","description":"Specifies how the payment is captured.\n- `automatic`: Funds are captured immediately after successful authorization. This is the default behavior if the field is omitted.\n- `manual`: Funds are authorized but not captured. A separate request to the `/payments/{payment_id}/capture` endpoint is required to capture the funds.","enum":["automatic","manual","manual_multiple","scheduled","sequential_automatic"],"isRequired":true,"uniqueKey":"capture_method","typeLabel":"enum\u003cstring>"},"customer_id":{"type":"string","description":"The identifier for the customer","example":"0a_cus_01926c58bc6e77c09e809964e72af8c8","maxLength":64,"minLength":32,"isRequired":true,"uniqueKey":"customer_id","typeLabel":"string"},"customer_present":{"type":"string","description":"Set to `present` to indicate that the customer is in your checkout flow during this payment, and therefore is able to authenticate. This parameter should be `absent` when merchant's doing merchant initiated payments and customer is not present while doing the payment.","enum":["present","absent"],"isRequired":true,"uniqueKey":"customer_present","typeLabel":"enum\u003cstring>"},"setup_future_usage":{"type":"string","description":"Specifies how the payment method can be used for future payments.\n- `off_session`: The payment method can be used for future payments when the customer is not present.\n- `on_session`: The payment method is intended for use only when the customer is present during checkout.\n\nIf omitted, defaults to `on_session`.","enum":["off_session","on_session"],"isRequired":true,"uniqueKey":"setup_future_usage","typeLabel":"enum\u003cstring>"},"apply_mit_exemption":{"type":"string","enum":["Apply","Skip"],"isRequired":true,"uniqueKey":"apply_mit_exemption","typeLabel":"enum\u003cstring>"},"payment_link_enabled":{"type":"string","description":"Whether payment link is requested to be enabled or not for this transaction","enum":["Enable","Skip"],"isRequired":true,"uniqueKey":"payment_link_enabled","typeLabel":"enum\u003cstring>"},"request_incremental_authorization":{"type":"string","enum":["true","false","default"],"isRequired":true,"uniqueKey":"request_incremental_authorization","typeLabel":"enum\u003cstring>"},"split_txns_enabled":{"type":"string","default":"skip","enum":["enable","skip"],"isRequired":true,"uniqueKey":"split_txns_enabled","typeLabel":"enum\u003cstring>"},"expires_on":{"type":"string","format":"date-time","description":"Will be used to expire client secret after certain amount of time to be supplied in seconds","isRequired":true,"uniqueKey":"expires_on","typeLabel":"string\u003cdate-time>"},"request_external_three_ds_authentication":{"type":"string","description":"Whether 3ds authentication is requested or not","enum":["Enable","Skip"],"isRequired":true,"uniqueKey":"request_external_three_ds_authentication","typeLabel":"enum\u003cstring>"},"payment_type":{"type":"string","description":"The type of the payment that differentiates between normal and various types of mandate payments. Use 'setup_mandate' in case of zero auth flow.","enum":["normal","new_mandate","setup_mandate","recurring_mandate","installment"],"isRequired":true,"uniqueKey":"payment_type","typeLabel":"enum\u003cstring>"},"merchant_reference_id":{"oneOf":[{"type":"string","description":"Unique identifier for the payment. This ensures idempotency for multiple payments\nthat have been done by a single merchant.","example":"pay_mbabizu24mvu3mela5njyhpit4","maxLength":30,"minLength":30,"uniqueKey":"merchant_reference_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier for the payment. This ensures idempotency for multiple payments\nthat have been done by a single merchant.","example":"pay_mbabizu24mvu3mela5njyhpit4","maxLength":30,"minLength":30,"uniqueKey":"merchant_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_reference_id","typeLabel":"string | null"},"routing_algorithm_id":{"oneOf":[{"type":"string","description":"The routing algorithm id to be used for the payment","uniqueKey":"routing_algorithm_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The routing algorithm id to be used for the payment","uniqueKey":"routing_algorithm_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"routing_algorithm_id","typeLabel":"string | null"},"authentication_type":{"oneOf":[{"type":"string","description":"Specifies the type of cardholder authentication to be applied for a payment.\n\n- `ThreeDs`: Requests 3D Secure (3DS) authentication. If the card is enrolled, 3DS authentication will be activated, potentially shifting chargeback liability to the issuer.\n- `NoThreeDs`: Indicates that 3D Secure authentication should not be performed. The liability for chargebacks typically remains with the merchant. This is often the default if not specified.\n\nNote: The actual authentication behavior can also be influenced by merchant configuration and specific connector defaults. Some connectors might still enforce 3DS or bypass it regardless of this parameter.","enum":["three_ds","no_three_ds"],"uniqueKey":"authentication_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"authentication_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"authentication_type","typeLabel":"enum\u003cstring> | null"},"billing":{"oneOf":[{"type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"Address details","properties":{"city":{"oneOf":[{"type":"string","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"billing.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"billing.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.country","typeLabel":"enum\u003cstring> | null"},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"line3":{"oneOf":[{"type":"string","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.line3","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The address state","example":"New York","uniqueKey":"billing.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address state","example":"New York","uniqueKey":"billing.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"billing.oneOf.0.address.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"billing.oneOf.0.address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"billing.oneOf.0.address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"billing.oneOf.0.address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.last_name","typeLabel":"string | null"},"origin_zip":{"oneOf":[{"type":"string","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.origin_zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"billing.oneOf.0.address.oneOf.0.origin_zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address.oneOf.0.origin_zip","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.address","typeLabel":"object | null"},"phone":{"oneOf":[{"type":"object","description":"Phone contact details shared by payment and payout API models.","properties":{"number":{"oneOf":[{"type":"string","description":"The contact number","example":"9123456789","uniqueKey":"billing.oneOf.0.phone.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The contact number","example":"9123456789","uniqueKey":"billing.oneOf.0.phone.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone.oneOf.0.number","typeLabel":"string | null"},"country_code":{"oneOf":[{"type":"string","description":"The country code attached to the number","example":"+1","uniqueKey":"billing.oneOf.0.phone.oneOf.0.country_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The country code attached to the number","example":"+1","uniqueKey":"billing.oneOf.0.phone.oneOf.0.country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone.oneOf.0.country_code","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0.phone.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.phone","typeLabel":"object | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"billing.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"billing.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"billing.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"billing.oneOf.1","typeLabel":"null"}],"uniqueKey":"billing","typeLabel":"object | null"},"shipping":{"oneOf":[{"type":"object","properties":{"address":{"oneOf":[{"type":"object","description":"Address details","properties":{"city":{"oneOf":[{"type":"string","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"shipping.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.country","typeLabel":"enum\u003cstring> | null"},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"line3":{"oneOf":[{"type":"string","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.line3","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The address state","example":"New York","uniqueKey":"shipping.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address state","example":"New York","uniqueKey":"shipping.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.last_name","typeLabel":"string | null"},"origin_zip":{"oneOf":[{"type":"string","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.origin_zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"shipping.oneOf.0.address.oneOf.0.origin_zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address.oneOf.0.origin_zip","typeLabel":"string | null"}},"uniqueKey":"shipping.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"shipping.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.address","typeLabel":"object | null"},"phone":{"oneOf":[{"type":"object","description":"Phone contact details shared by payment and payout API models.","properties":{"number":{"oneOf":[{"type":"string","description":"The contact number","example":"9123456789","uniqueKey":"shipping.oneOf.0.phone.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The contact number","example":"9123456789","uniqueKey":"shipping.oneOf.0.phone.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.phone.oneOf.0.number","typeLabel":"string | null"},"country_code":{"oneOf":[{"type":"string","description":"The country code attached to the number","example":"+1","uniqueKey":"shipping.oneOf.0.phone.oneOf.0.country_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The country code attached to the number","example":"+1","uniqueKey":"shipping.oneOf.0.phone.oneOf.0.country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.phone.oneOf.0.country_code","typeLabel":"string | null"}},"uniqueKey":"shipping.oneOf.0.phone.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"shipping.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.phone","typeLabel":"object | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"shipping.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"shipping.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping.oneOf.0.email","typeLabel":"string | null"}},"uniqueKey":"shipping.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipping","typeLabel":"object | null"},"description":{"oneOf":[{"type":"string","description":"A description for the payment","example":"It's my first payment request","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description for the payment","example":"It's my first payment request","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"return_url":{"oneOf":[{"type":"string","description":"The URL to which you want the user to be redirected after the completion of the payment operation","example":"https://hyperswitch.io","uniqueKey":"return_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL to which you want the user to be redirected after the completion of the payment operation","example":"https://hyperswitch.io","uniqueKey":"return_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"return_url","typeLabel":"string | null"},"statement_descriptor":{"oneOf":[{"type":"string","description":"For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.","example":"Hyperswitch Router","maxLength":22,"uniqueKey":"statement_descriptor.oneOf.0","typeLabel":"string"},{"type":"null","description":"For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.","example":"Hyperswitch Router","maxLength":22,"uniqueKey":"statement_descriptor.oneOf.1","typeLabel":"null"}],"uniqueKey":"statement_descriptor","typeLabel":"string | null"},"order_details":{"oneOf":[{"type":"array","items":{"type":"object","required":["product_name","quantity","amount"],"properties":{"product_name":{"type":"string","description":"Name of the product that is being purchased","example":"shirt","maxLength":255,"isRequired":true,"uniqueKey":"order_details.oneOf.0.items.[INDEX].product_name","typeLabel":"string"},"quantity":{"type":"integer","format":"int32","description":"The quantity of the product to be purchased","example":1,"minimum":0,"isRequired":true,"uniqueKey":"order_details.oneOf.0.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"amount":{"type":"integer","format":"int64","description":"the amount per quantity of product","isRequired":true,"uniqueKey":"order_details.oneOf.0.items.[INDEX].amount","typeLabel":"integer\u003cint64>"},"tax_rate":{"oneOf":[{"type":"number","format":"double","description":"tax rate applicable to the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].tax_rate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"tax rate applicable to the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].tax_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].tax_rate","typeLabel":"number\u003cdouble> | null"},"total_tax_amount":{"oneOf":[{"type":"integer","format":"int64","description":"total tax amount applicable to the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].total_tax_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"total tax amount applicable to the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].total_tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].total_tax_amount","typeLabel":"integer\u003cint64> | null"},"requires_shipping":{"oneOf":[{"type":"boolean","uniqueKey":"order_details.oneOf.0.items.[INDEX].requires_shipping.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"order_details.oneOf.0.items.[INDEX].requires_shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].requires_shipping","typeLabel":"boolean | null"},"product_img_link":{"oneOf":[{"type":"string","description":"The image URL of the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_img_link.oneOf.0","typeLabel":"string"},{"type":"null","description":"The image URL of the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_img_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].product_img_link","typeLabel":"string | null"},"product_id":{"oneOf":[{"type":"string","description":"ID of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].product_id","typeLabel":"string | null"},"category":{"oneOf":[{"type":"string","description":"Category of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].category.oneOf.0","typeLabel":"string"},{"type":"null","description":"Category of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].category.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].category","typeLabel":"string | null"},"sub_category":{"oneOf":[{"type":"string","description":"Sub category of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].sub_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"Sub category of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].sub_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].sub_category","typeLabel":"string | null"},"brand":{"oneOf":[{"type":"string","description":"Brand of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].brand.oneOf.0","typeLabel":"string"},{"type":"null","description":"Brand of the product that is being purchased","uniqueKey":"order_details.oneOf.0.items.[INDEX].brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].brand","typeLabel":"string | null"},"product_type":{"oneOf":[{"type":"string","enum":["physical","digital","travel","ride","event","accommodation"],"uniqueKey":"order_details.oneOf.0.items.[INDEX].product_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].product_type","typeLabel":"enum\u003cstring> | null"},"product_tax_code":{"oneOf":[{"type":"string","description":"The tax code for the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_tax_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax code for the product","uniqueKey":"order_details.oneOf.0.items.[INDEX].product_tax_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].product_tax_code","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Description for the item","uniqueKey":"order_details.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description for the item","uniqueKey":"order_details.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","description":"Stock Keeping Unit (SKU) or the item identifier for this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"Stock Keeping Unit (SKU) or the item identifier for this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].sku","typeLabel":"string | null"},"upc":{"oneOf":[{"type":"string","description":"Universal Product Code for the item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].upc.oneOf.0","typeLabel":"string"},{"type":"null","description":"Universal Product Code for the item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].upc.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].upc","typeLabel":"string | null"},"commodity_code":{"oneOf":[{"type":"string","description":"Code describing a commodity or a group of commodities pertaining to goods classification.","uniqueKey":"order_details.oneOf.0.items.[INDEX].commodity_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Code describing a commodity or a group of commodities pertaining to goods classification.","uniqueKey":"order_details.oneOf.0.items.[INDEX].commodity_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].commodity_code","typeLabel":"string | null"},"unit_of_measure":{"oneOf":[{"type":"string","description":"Unit of measure used for the item quantity.","uniqueKey":"order_details.oneOf.0.items.[INDEX].unit_of_measure.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unit of measure used for the item quantity.","uniqueKey":"order_details.oneOf.0.items.[INDEX].unit_of_measure.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].unit_of_measure","typeLabel":"string | null"},"total_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Total amount for the item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].total_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Total amount for the item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].total_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].total_amount","typeLabel":"integer\u003cint64> | null"},"discount_name":{"oneOf":[{"type":"string","description":"Discount name applied to this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Discount name applied to this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_name","typeLabel":"string | null"},"unit_discount_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Discount amount applied to this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].unit_discount_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Discount amount applied to this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].unit_discount_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].unit_discount_amount","typeLabel":"integer\u003cint64> | null"},"discount_percentage":{"oneOf":[{"type":"object","description":"Represents Percentage Value between 0 and 100 both inclusive","required":["percentage"],"properties":{"percentage":{"type":"number","format":"double","description":"Percentage value ranging between 0 and 100","isRequired":true,"uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_percentage.oneOf.0.percentage","typeLabel":"number\u003cdouble>"}},"uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_percentage.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_percentage","typeLabel":"object | null"},"discount_type":{"oneOf":[{"type":"string","description":"Discount type applied to this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Discount type applied to this item.","uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details.oneOf.0.items.[INDEX].discount_type","typeLabel":"string | null"}},"uniqueKey":"order_details.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount","example":"[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]","uniqueKey":"order_details.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","required":["product_name","quantity","amount"],"properties":{"product_name":{"type":"string","description":"Name of the product that is being purchased","example":"shirt","maxLength":255},"quantity":{"type":"integer","format":"int32","description":"The quantity of the product to be purchased","example":1,"minimum":0},"amount":{"type":"integer","format":"int64","description":"the amount per quantity of product"},"tax_rate":{"oneOf":[{"type":"number","format":"double","description":"tax rate applicable to the product"},{"type":"null","format":"double","description":"tax rate applicable to the product"}]},"total_tax_amount":{"oneOf":[{"type":"integer","format":"int64","description":"total tax amount applicable to the product"},{"type":"null","format":"int64","description":"total tax amount applicable to the product"}]},"requires_shipping":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"product_img_link":{"oneOf":[{"type":"string","description":"The image URL of the product"},{"type":"null","description":"The image URL of the product"}]},"product_id":{"oneOf":[{"type":"string","description":"ID of the product that is being purchased"},{"type":"null","description":"ID of the product that is being purchased"}]},"category":{"oneOf":[{"type":"string","description":"Category of the product that is being purchased"},{"type":"null","description":"Category of the product that is being purchased"}]},"sub_category":{"oneOf":[{"type":"string","description":"Sub category of the product that is being purchased"},{"type":"null","description":"Sub category of the product that is being purchased"}]},"brand":{"oneOf":[{"type":"string","description":"Brand of the product that is being purchased"},{"type":"null","description":"Brand of the product that is being purchased"}]},"product_type":{"oneOf":[{"type":"string","enum":["physical","digital","travel","ride","event","accommodation"]},{"type":"null"}]},"product_tax_code":{"oneOf":[{"type":"string","description":"The tax code for the product"},{"type":"null","description":"The tax code for the product"}]},"description":{"oneOf":[{"type":"string","description":"Description for the item"},{"type":"null","description":"Description for the item"}]},"sku":{"oneOf":[{"type":"string","description":"Stock Keeping Unit (SKU) or the item identifier for this item."},{"type":"null","description":"Stock Keeping Unit (SKU) or the item identifier for this item."}]},"upc":{"oneOf":[{"type":"string","description":"Universal Product Code for the item."},{"type":"null","description":"Universal Product Code for the item."}]},"commodity_code":{"oneOf":[{"type":"string","description":"Code describing a commodity or a group of commodities pertaining to goods classification."},{"type":"null","description":"Code describing a commodity or a group of commodities pertaining to goods classification."}]},"unit_of_measure":{"oneOf":[{"type":"string","description":"Unit of measure used for the item quantity."},{"type":"null","description":"Unit of measure used for the item quantity."}]},"total_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Total amount for the item."},{"type":"null","format":"int64","description":"Total amount for the item."}]},"discount_name":{"oneOf":[{"type":"string","description":"Discount name applied to this item."},{"type":"null","description":"Discount name applied to this item."}]},"unit_discount_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Discount amount applied to this item."},{"type":"null","format":"int64","description":"Discount amount applied to this item."}]},"discount_percentage":{"oneOf":[{"type":"object","description":"Represents Percentage Value between 0 and 100 both inclusive","required":["percentage"],"properties":{"percentage":{"type":"number","format":"double","description":"Percentage value ranging between 0 and 100"}}},{"type":"null"}]},"discount_type":{"oneOf":[{"type":"string","description":"Discount type applied to this item."},{"type":"null","description":"Discount type applied to this item."}]}}},"description":"Use this object to capture the details about the different products for which the payment is being made. The sum of amount across different products here should be equal to the overall payment amount","example":"[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]","uniqueKey":"order_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_details","typeLabel":"object[] | null"},"allowed_payment_method_types":{"oneOf":[{"type":"array","items":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eft_debit_order","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","neteller","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","pix_key","pix_emv","pix_qr","pix_automatico_qr","pix_automatico_push","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","wero","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","payshap","payshap_proxy","ted"],"uniqueKey":"allowed_payment_method_types.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent","uniqueKey":"allowed_payment_method_types.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eft_debit_order","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","neteller","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","pix_key","pix_emv","pix_qr","pix_automatico_qr","pix_automatico_push","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","wero","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","payshap","payshap_proxy","ted"]},"description":"Use this parameter to restrict the Payment Method Types to show for a given PaymentIntent","uniqueKey":"allowed_payment_method_types.oneOf.1","typeLabel":"null"}],"uniqueKey":"allowed_payment_method_types","typeLabel":"enum\u003cstring>[] | 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"},"connector_metadata":{"oneOf":[{"type":"object","description":"Some connectors like Apple Pay, Airwallex and Noon might require some additional information, find specific details in the child attributes below.","properties":{"apple_pay":{"oneOf":[{"type":"object","properties":{"session_token_data":{"oneOf":[{"type":"object","required":["certificate","certificate_keys","merchant_identifier","display_name","initiative","payment_processing_details_at","payment_processing_certificate","payment_processing_certificate_key"],"properties":{"payment_processing_certificate":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.payment_processing_certificate","typeLabel":"string"},"payment_processing_certificate_key":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.payment_processing_certificate_key","typeLabel":"string"},"payment_processing_details_at":{"type":"string","enum":["Hyperswitch"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.payment_processing_details_at","typeLabel":"enum\u003cstring>"},"certificate":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.certificate","typeLabel":"string"},"certificate_keys":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.certificate_keys","typeLabel":"string"},"merchant_identifier":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.merchant_identifier","typeLabel":"string"},"display_name":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.display_name","typeLabel":"string"},"initiative":{"type":"string","enum":["web","ios"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.initiative","typeLabel":"enum\u003cstring>"},"initiative_context":{"oneOf":[{"type":"string","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.initiative_context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.initiative_context.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.initiative_context","typeLabel":"string | 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":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.merchant_business_country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.merchant_business_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.merchant_business_country","typeLabel":"enum\u003cstring> | null"},"payment_processing_detail_input_type":{"oneOf":[{"type":"string","description":"Specifies how the Apple Pay payment processing details are supplied.","enum":["raw","link_hierarchical_resource"],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.payment_processing_detail_input_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.payment_processing_detail_input_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0.payment_processing_detail_input_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.0","typeLabel":"object"},{"type":"object","required":["certificate","certificate_keys","merchant_identifier","display_name","initiative","payment_processing_details_at"],"properties":{"payment_processing_details_at":{"type":"string","enum":["Connector"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.payment_processing_details_at","typeLabel":"enum\u003cstring>"},"certificate":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.certificate","typeLabel":"string"},"certificate_keys":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.certificate_keys","typeLabel":"string"},"merchant_identifier":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.merchant_identifier","typeLabel":"string"},"display_name":{"type":"string","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.display_name","typeLabel":"string"},"initiative":{"type":"string","enum":["web","ios"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.initiative","typeLabel":"enum\u003cstring>"},"initiative_context":{"oneOf":[{"type":"string","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.initiative_context.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.initiative_context.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.initiative_context","typeLabel":"string | 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":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.merchant_business_country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.merchant_business_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.merchant_business_country","typeLabel":"enum\u003cstring> | null"},"payment_processing_detail_input_type":{"oneOf":[{"type":"string","description":"Specifies how the Apple Pay payment processing details are supplied.","enum":["raw","link_hierarchical_resource"],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.payment_processing_detail_input_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.payment_processing_detail_input_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1.payment_processing_detail_input_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data.oneOf.2","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0.session_token_data","typeLabel":"object · object · null"}},"uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.apple_pay.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.apple_pay","typeLabel":"object | null"},"airwallex":{"oneOf":[{"type":"object","properties":{"payload":{"oneOf":[{"type":"string","description":"payload required by airwallex","uniqueKey":"connector_metadata.oneOf.0.airwallex.oneOf.0.payload.oneOf.0","typeLabel":"string"},{"type":"null","description":"payload required by airwallex","uniqueKey":"connector_metadata.oneOf.0.airwallex.oneOf.0.payload.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.airwallex.oneOf.0.payload","typeLabel":"string | null"}},"uniqueKey":"connector_metadata.oneOf.0.airwallex.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.airwallex.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.airwallex","typeLabel":"object | null"},"noon":{"oneOf":[{"type":"object","properties":{"order_category":{"oneOf":[{"type":"string","description":"Information about the order category that merchant wants to specify at connector level. (e.g. In Noon Payments it can take values like \"pay\", \"food\", or any other custom string set by the merchant in Noon's Dashboard)","uniqueKey":"connector_metadata.oneOf.0.noon.oneOf.0.order_category.oneOf.0","typeLabel":"string"},{"type":"null","description":"Information about the order category that merchant wants to specify at connector level. (e.g. In Noon Payments it can take values like \"pay\", \"food\", or any other custom string set by the merchant in Noon's Dashboard)","uniqueKey":"connector_metadata.oneOf.0.noon.oneOf.0.order_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.noon.oneOf.0.order_category","typeLabel":"string | null"}},"uniqueKey":"connector_metadata.oneOf.0.noon.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.noon.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.noon","typeLabel":"object | null"},"braintree":{"oneOf":[{"type":"object","required":["merchant_account_id","merchant_config_currency"],"properties":{"merchant_account_id":{"type":"string","description":"Information about the merchant_account_id that merchant wants to specify at connector level.","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.braintree.oneOf.0.merchant_account_id","typeLabel":"string"},"merchant_config_currency":{"type":"string","description":"Information about the merchant_config_currency that merchant wants to specify at connector level.","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.braintree.oneOf.0.merchant_config_currency","typeLabel":"string"}},"uniqueKey":"connector_metadata.oneOf.0.braintree.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.braintree.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.braintree","typeLabel":"object | null"},"adyen":{"oneOf":[{"type":"object","required":["testing"],"properties":{"testing":{"type":"object","required":["holder_name"],"properties":{"holder_name":{"type":"string","description":"Holder name to be sent to Adyen for a card payment(CIT) or a generic payment(MIT). This value overrides the values for card.card_holder_name and applies during both CIT and MIT payment transactions.","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.adyen.oneOf.0.testing.holder_name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.adyen.oneOf.0.testing","typeLabel":"object"}},"uniqueKey":"connector_metadata.oneOf.0.adyen.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.adyen.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.adyen","typeLabel":"object | null"},"peachpayments":{"oneOf":[{"type":"object","properties":{"rrn":{"oneOf":[{"type":"string","description":"A numeric reference number supplied by the system retaining the original source information and used to assist in locating that information or a copy thereof.","uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0.rrn.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric reference number supplied by the system retaining the original source information and used to assist in locating that information or a copy thereof.","uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0.rrn.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0.rrn","typeLabel":"string | null"},"card_on_file_transaction_type":{"oneOf":[{"type":"string","enum":["one_off","customer_initiated_transaction","merchant_initiated_mandate","merchant_initiated_transaction"],"uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0.card_on_file_transaction_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0.card_on_file_transaction_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0.card_on_file_transaction_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.peachpayments.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.peachpayments","typeLabel":"object | null"},"santander":{"oneOf":[{"type":"object","description":"Represents the connector-specific metadata for Santander payments, including boleto data and related rules.","properties":{"boleto":{"oneOf":[{"type":"object","description":"Represents the specific data and rules related to Santander Boleto payments, including discounts, penalties, collection actions, payment constraints, beneficiary details, and document kind.","properties":{"discount_rules":{"oneOf":[{"type":"object","description":"Defines the type of discount applied to a payment, such as whether it's a fixed date discount, a daily calendar discount, or a daily business discount.","required":["tiers"],"properties":{"tiers":{"type":"array","items":{"type":"object","properties":{"amount":{"oneOf":[{"type":"string","description":"The discount value (e.g., \"5.50\").","example":"5.50","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"The discount value (e.g., \"5.50\").","example":"5.50","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].amount","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","description":"The ISO-8601 date until which this discount is valid","example":"2027-12-31","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].end_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ISO-8601 date until which this discount is valid","example":"2027-12-31","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].end_date","typeLabel":"string | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX]","typeLabel":"object"},"description":"A generic vector of discount tiers","isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.tiers","typeLabel":"object[]"},"discount_type":{"oneOf":[{"type":"string","description":"Defines the type of discount applied to a payment, such as whether it's a fixed date discount, a daily calendar discount, or a daily business discount.","enum":["standard","fixed_date","daily_calendar","daily_business"],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.discount_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.discount_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0.discount_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.discount_rules","typeLabel":"object | null"},"penalties":{"oneOf":[{"type":"object","description":"Represents the rules for applying discounts to a payment, such as a percentage discount or a fixed amount discount, along with any applicable grace periods.","properties":{"fixed_penalty":{"oneOf":[{"type":"object","description":"Represents the rules for applying discounts to a payment, such as a percentage discount or a fixed amount discount, along with any applicable grace periods.","properties":{"value":{"oneOf":[{"type":"string","description":"The numeric value (as a string to preserve decimal precision)","example":"2.00","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"The numeric value (as a string to preserve decimal precision)","example":"2.00","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.value","typeLabel":"string | null"},"grace_period_days":{"oneOf":[{"type":"integer","format":"int32","description":"Grace period: Days after due date before this applies","example":1,"minimum":0,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.grace_period_days.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Grace period: Days after due date before this applies","example":1,"minimum":0,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.grace_period_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.grace_period_days","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.fixed_penalty","typeLabel":"object | null"},"interest":{"oneOf":[{"type":"object","description":"Represents the rules for applying discounts to a payment, such as a percentage discount or a fixed amount discount, along with any applicable grace periods.","properties":{"interest_percentage":{"oneOf":[{"type":"string","description":"Percentage of Juros (Interest). Pattern: ^[0-9]{1,3}\\.[0-9]{2}$","example":"5.00","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0.interest_percentage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Percentage of Juros (Interest). Pattern: ^[0-9]{1,3}\\.[0-9]{2}$","example":"5.00","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0.interest_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0.interest_percentage","typeLabel":"string | null"},"iof_percentage":{"oneOf":[{"type":"string","description":"Percentage of IOF (Financial Operations Tax). Pattern: \\d{3}$\\.\\d{5}\nOnly provided if the agreement is \"Cobra IOF na Barra ou Cadastro\"","example":"32.45325","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0.iof_percentage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Percentage of IOF (Financial Operations Tax). Pattern: \\d{3}$\\.\\d{5}\nOnly provided if the agreement is \"Cobra IOF na Barra ou Cadastro\"","example":"32.45325","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0.iof_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0.iof_percentage","typeLabel":"string | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0.interest","typeLabel":"object | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.penalties","typeLabel":"object | null"},"collection_actions":{"oneOf":[{"type":"object","description":"Represents the legal or administrative actions that may be taken for non-payment, such as protest rules and automatic write-off timelines.","properties":{"legal_protest":{"oneOf":[{"type":"object","required":["protest_type","days_after_due_date"],"properties":{"protest_type":{"type":"string","description":"Defines the type of protest for non-payment, such as whether the count is based on calendar days, business days, or if the protest logic is determined by a pre-signed contract with the bank.","enum":["disabled","calendar_days","business_days","contract_default"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.0.protest_type","typeLabel":"enum\u003cstring>"},"days_after_due_date":{"type":"integer","format":"int32","description":"Number of days after the due date to initiate the protest","example":30,"minimum":0,"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.0.days_after_due_date","typeLabel":"integer\u003cint32>"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.legal_protest","typeLabel":"object | null"},"auto_write_off_days":{"oneOf":[{"type":"integer","format":"int32","description":"Days after which the bill is automatically cancelled/written off","example":60,"minimum":0,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.auto_write_off_days.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Days after which the bill is automatically cancelled/written off","example":60,"minimum":0,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.auto_write_off_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0.auto_write_off_days","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.collection_actions","typeLabel":"object | null"},"payment_constraints":{"oneOf":[{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","required":["type"],"properties":{"type":{"type":"string","enum":["fixed_amount"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.0","typeLabel":"object"},{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","required":["type","details"],"properties":{"type":{"type":"string","enum":["flexible_amount"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.type","typeLabel":"enum\u003cstring>"},"details":{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","properties":{"min_value":{"oneOf":[{"type":"string","description":"Minimum value allowed (e.g., \"10.00\")","example":"38.02","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.min_value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Minimum value allowed (e.g., \"10.00\")","example":"38.02","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.min_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.min_value","typeLabel":"string | null"},"max_value":{"oneOf":[{"type":"string","description":"Maximum value allowed (e.g., \"5000.00\")","example":"38.02","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.max_value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Maximum value allowed (e.g., \"5000.00\")","example":"38.02","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.max_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.max_value","typeLabel":"string | null"},"value_type":{"oneOf":[{"type":"string","description":"Defines how the payment amount is calculated for penalties or discounts, either as a percentage or as a flat amount.","enum":["percentage","flat_amount"],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.value_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.value_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details.value_type","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1.details","typeLabel":"object"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.1","typeLabel":"object"},{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","required":["type","details"],"properties":{"type":{"type":"string","enum":["installment"],"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.type","typeLabel":"enum\u003cstring>"},"details":{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","properties":{"max_partial_payments":{"oneOf":[{"type":"integer","format":"int32","description":"Maximum number of partial payments allowed (Up to 99 for Santander).","example":99,"minimum":0,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details.max_partial_payments.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Maximum number of partial payments allowed (Up to 99 for Santander).","example":99,"minimum":0,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details.max_partial_payments.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details.max_partial_payments","typeLabel":"integer\u003cint32> | null"},"value_type":{"oneOf":[{"type":"string","description":"Defines how the payment amount is calculated for penalties or discounts, either as a percentage or as a flat amount.","enum":["percentage","flat_amount"],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details.value_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details.value_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details.value_type","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2.details","typeLabel":"object"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints.oneOf.3","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.payment_constraints","typeLabel":"object · object · object · null"},"beneficiary":{"oneOf":[{"type":"object","description":"Represents the end-recipient of a payout or fund transfer.","properties":{"name":{"oneOf":[{"type":"string","description":"The full legal name of the individual or entity receiving the funds.","example":"João da Silva","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full legal name of the individual or entity receiving the funds.","example":"João da Silva","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.name","typeLabel":"string | null"},"document_number":{"oneOf":[{"type":"string","description":"The customer's unique identification number (e.g., Tax ID, SSN, Passport Number).\nUsed by processors to verify the identity of the recipient and prevent fraud.\nLength of the document number depends upon the document_type.\nFor CPF/CNPJ it is typically 11/14 digits long.","example":"9615865832","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.document_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's unique identification number (e.g., Tax ID, SSN, Passport Number).\nUsed by processors to verify the identity of the recipient and prevent fraud.\nLength of the document number depends upon the document_type.\nFor CPF/CNPJ it is typically 11/14 digits long.","example":"9615865832","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.document_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.document_number","typeLabel":"string | null"},"document_type":{"oneOf":[{"type":"string","description":"Represents the type of identification document used for validation.","enum":["cpf","cnpj","psn","other"],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.document_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.document_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0.document_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.beneficiary","typeLabel":"object | null"},"document_kind":{"oneOf":[{"type":"string","enum":["commercial_invoice","service_invoice","promissory_note","rural_promissory_note","receipt","insurance_policy","credit_card_invoice","proposal","deposit_or_funding","cheque","direct_promissory_note","other"],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.document_kind.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.document_kind.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0.document_kind","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0.boleto","typeLabel":"object | null"}},"uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.santander.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.santander","typeLabel":"object | null"},"paypal":{"oneOf":[{"type":"object","description":"PayPal-specific metadata supplied with a payment request.","properties":{"paypal_client_metadata_id":{"oneOf":[{"type":"string","description":"FraudNet session identifier sent in the PAYPAL-CLIENT-METADATA-ID request header.","uniqueKey":"connector_metadata.oneOf.0.paypal.oneOf.0.paypal_client_metadata_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"FraudNet session identifier sent in the PAYPAL-CLIENT-METADATA-ID request header.","uniqueKey":"connector_metadata.oneOf.0.paypal.oneOf.0.paypal_client_metadata_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.paypal.oneOf.0.paypal_client_metadata_id","typeLabel":"string | null"}},"uniqueKey":"connector_metadata.oneOf.0.paypal.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.paypal.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.paypal","typeLabel":"object | null"},"worldpayxml":{"oneOf":[{"type":"object","properties":{"funding_transaction_type":{"oneOf":[{"type":"string","enum":["credit_card_bill_repayment","gift_card_purchase","gift_card_purchase_for_another","non_reloadable_prepaid_card","reloadable_prepaid_card_or_account","gaming_chips_purchase","gaming_stored_value_wallet","gaming_staged_digital_wallet","liquid_and_crypto_assets_purchase","liquid_and_crypto_stored_value_wallet_load","stored_value_digital_wallet_load","stored_value_digital_wallet_load_non_securities","securities_stored_value_digital_wallet_load","securities_staged_digital_wallet_load","single_merchant_wallet_load","debit_card_load","transfer_to_own_debit_account","funds_transfer_me_to_me","account_to_account","back_to_back_p2p_without_wallet","back_to_back_p2p_with_wallet","agent_cash_out","staged_digital_wallet_load","staged_digital_wallet_purchase","back_to_back_card_purchase","payroll_disbursement_funding","business_to_consumer_disbursement","business_to_business_invoice_payment"],"uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0.funding_transaction_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0.funding_transaction_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0.funding_transaction_type","typeLabel":"enum\u003cstring> | null"},"payment_purpose":{"oneOf":[{"type":"string","enum":["family_support","regular_labour_transfers","travel_and_tourism","education","hospitalisation_and_medical_treatment","emergency_need","savings","gifts","other","salary","crowd_lending","crypto_currency","high_risk_securities"],"uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0.payment_purpose.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0.payment_purpose.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0.payment_purpose","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.worldpayxml.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.worldpayxml","typeLabel":"object | null"},"checkout":{"oneOf":[{"type":"object","properties":{"purpose_of_payment":{"oneOf":[{"type":"string","description":"Purpose of Payment. Required for AFT.","example":"wallet top-up","uniqueKey":"connector_metadata.oneOf.0.checkout.oneOf.0.purpose_of_payment.oneOf.0","typeLabel":"string"},{"type":"null","description":"Purpose of Payment. Required for AFT.","example":"wallet top-up","uniqueKey":"connector_metadata.oneOf.0.checkout.oneOf.0.purpose_of_payment.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.checkout.oneOf.0.purpose_of_payment","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"connector_metadata.oneOf.0.checkout.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.checkout.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.checkout","typeLabel":"object | null"},"stripe":{"oneOf":[{"type":"object","properties":{"error_on_requires_action":{"oneOf":[{"type":"boolean","description":"For MIT (merchant-initiated) payments: when true, Stripe fails the payment outright\ninstead of returning a `requires_action` status, since there's no customer present to\ncomplete additional authentication.","uniqueKey":"connector_metadata.oneOf.0.stripe.oneOf.0.error_on_requires_action.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"For MIT (merchant-initiated) payments: when true, Stripe fails the payment outright\ninstead of returning a `requires_action` status, since there's no customer present to\ncomplete additional authentication.","uniqueKey":"connector_metadata.oneOf.0.stripe.oneOf.0.error_on_requires_action.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.stripe.oneOf.0.error_on_requires_action","typeLabel":"boolean | null"}},"uniqueKey":"connector_metadata.oneOf.0.stripe.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.0.stripe.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata.oneOf.0.stripe","typeLabel":"object | null"}},"uniqueKey":"connector_metadata.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"connector_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"connector_metadata","typeLabel":"object | null"},"feature_metadata":{"oneOf":[{"type":"object","description":"additional data that might be required by hyperswitch","properties":{"redirect_response":{"oneOf":[{"type":"object","properties":{"param":{"oneOf":[{"type":"string","uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0.param.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0.param","typeLabel":"string | null"},"json_payload":{"oneOf":[{"type":"object","uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0.json_payload.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0.json_payload.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0.json_payload","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.redirect_response.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.redirect_response","typeLabel":"object | null"},"search_tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"feature_metadata.oneOf.0.search_tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Additional tags to be used for global search","uniqueKey":"feature_metadata.oneOf.0.search_tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Additional tags to be used for global search","uniqueKey":"feature_metadata.oneOf.0.search_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.search_tags","typeLabel":"string[] | null"},"apple_pay_recurring_details":{"oneOf":[{"type":"object","required":["payment_description","regular_billing","management_url"],"properties":{"payment_description":{"type":"string","description":"A description of the recurring payment that Apple Pay displays to the user in the payment sheet","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.payment_description","typeLabel":"string"},"regular_billing":{"type":"object","required":["label"],"properties":{"label":{"type":"string","description":"The label that Apple Pay displays to the user in the payment sheet with the recurring details","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.label","typeLabel":"string"},"recurring_payment_start_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date of the first payment","example":"2023-09-10T23:59:59Z","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_start_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date of the first payment","example":"2023-09-10T23:59:59Z","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_start_date","typeLabel":"string\u003cdate-time> | null"},"recurring_payment_end_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date of the final payment","example":"2023-09-10T23:59:59Z","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_end_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date of the final payment","example":"2023-09-10T23:59:59Z","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_end_date","typeLabel":"string\u003cdate-time> | null"},"recurring_payment_interval_unit":{"oneOf":[{"type":"string","enum":["year","month","day","hour","minute"],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_interval_unit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_interval_unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_interval_unit","typeLabel":"enum\u003cstring> | null"},"recurring_payment_interval_count":{"oneOf":[{"type":"integer","format":"int32","description":"The number of interval units that make up the total payment interval","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_interval_count.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"The number of interval units that make up the total payment interval","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_interval_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing.recurring_payment_interval_count","typeLabel":"integer\u003cint32> | null"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.regular_billing","typeLabel":"object"},"management_url":{"type":"string","description":"A URL to a web page where the user can update or delete the payment method for the recurring payment","example":"https://hyperswitch.io","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.management_url","typeLabel":"string"},"billing_agreement":{"oneOf":[{"type":"string","description":"A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.billing_agreement.oneOf.0","typeLabel":"string"},{"type":"null","description":"A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.billing_agreement.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0.billing_agreement","typeLabel":"string | null"}},"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.apple_pay_recurring_details","typeLabel":"object | null"},"revenue_recovery":{"oneOf":[{"type":"object","required":["total_retry_count","billing_connector_payment_details","payment_method_type","payment_method_subtype","connector","billing_connector_payment_method_details"],"properties":{"total_retry_count":{"type":"integer","format":"int32","description":"Total number of billing connector + recovery retries for a payment intent.","example":"1","minimum":0,"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.total_retry_count","typeLabel":"integer\u003cint32>"},"billing_connector_payment_details":{"type":"object","required":["payment_processor_token","connector_customer_id"],"properties":{"payment_processor_token":{"type":"string","description":"Payment Processor Token to process the Revenue Recovery Payment","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_details.payment_processor_token","typeLabel":"string"},"connector_customer_id":{"type":"string","description":"Billing Connector's Customer Id","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_details.connector_customer_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_details","typeLabel":"object"},"payment_method_type":{"type":"string","description":"Indicates the type of payment method. Eg: 'card', 'wallet', etc.","enum":["card","card_redirect","pay_later","wallet","bank_redirect","bank_transfer","crypto","bank_debit","reward","real_time_payment","upi","voucher","gift_card","open_banking","mobile_payment","network_token"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.payment_method_type","typeLabel":"enum\u003cstring>"},"payment_method_subtype":{"type":"string","description":"Indicates the sub type of payment method. Eg: 'google_pay' \u0026 'apple_pay' for wallets.","enum":["ach","affirm","afterpay_clearpay","alfamart","ali_pay","ali_pay_hk","alma","amazon_pay","paysera","apple_pay","atome","bacs","bancontact_card","becs","benefit","bizum","blik","bluecode","boleto","bca_bank_transfer","bni_va","breadpay","bri_va","bhn_card_network","card_redirect","cimb_va","classic","credit","crypto_currency","cashapp","dana","danamon_va","debit","duit_now","efecty","eft","eft_debit_order","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","neteller","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","pix_key","pix_emv","pix_qr","pix_automatico_qr","pix_automatico_push","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","wero","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","payshap","payshap_proxy","ted"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.payment_method_subtype","typeLabel":"enum\u003cstring>"},"connector":{"type":"string","enum":["absa_sanlam","authipay","adyenplatform","stripe_billing_test","phonypay","fauxpay","pretendpay","stripe_test","adyen_test","checkout_test","paypal_test","aci","adyen","affirm","airwallex","amazonpay","archipel","authorizedotnet","bambora","bamboraapac","bankofamerica","barclaycard","betterpayment","billwerk","bitpay","bluesnap","blackhawknetwork","calida","boku","braintree","breadpay","cardinal","cashtocode","celero","chargebee","checkbook","checkout","citigate","coinbase","coingate","custombilling","cryptopay","ctp_mastercard","ctp_visa","cybersource","cybersourcedecisionmanager","d24","datatrans","deutschebank","digitalvirgo","dlocal","dwolla","ebanx","ecommpay","envoy","elavon","etisalat","elavon_pg","facilitapay","finix","fiserv","fiservemea","fiservcommercehub","fiuu","flexiti","forte","getnet","gigadat","givepayments","globalpay","globalpayments_heartland","globalpayments_realex","globepay","gocardless","gotyme_sanlam","gpayments","hipay","helcim","hyperpg","hyperswitch_vault","interpayments","inespay","iatapay","ilixium","imerchantsolutions","itaubank","jpmorgan","jpmorgan_orbital","juspay","juspaythreedsserver","klarna","loonio","merchante","mifinity","mollie","moneris","multisafepay","netcetera","nexinets","nexixpay","nmi","nomupay","noon","nordea","novalnet","nuvei","opennode","paybox","paydotcom","payload","payme","paynearme","payone","paypal","paysafe","paystack","paytm","payconex","payu","peachpayments","payjustnow","payjustnowinstore","phonepe","placetopay","powertranz","prophetpay","rapyd","razorpay","recurly","redsys","revolv3","saferpay","santander","shift4","silverflow","square","stax","stripe","stripebilling","taxjar","threedsecureio","tesouro","tokenex","tokenio","trustly","truelayer","trustpay","trustpayments","tsys","tsys_transit","vgs","volt","wellsfargo","wise","worldline","worldpay","worldpayraft","worldpayvantiv","worldpayxml","worldpaymodular","signifyd","nsure","plaid","riskified","sanlam_payshield","xendit","zen","zift","zsl"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.connector","typeLabel":"enum\u003cstring>"},"billing_connector_payment_method_details":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["card"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.type","typeLabel":"enum\u003cstring>"},"value":{"type":"object","required":["card_network"],"properties":{"card_network":{"type":"string","description":"Indicates the card network.","enum":["Visa","Mastercard","AmericanExpress","JCB","DinersClub","Discover","CartesBancaires","UnionPay","Interac","RuPay","Maestro","Star","Pulse","Accel","Nyce","Prop","PrivateLabel","Dinacard","AirPlus","Aurore","EftposAustralia","GeCapital","Uatp"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_network","typeLabel":"enum\u003cstring>"},"card_issuer":{"oneOf":[{"type":"string","description":"Card Issuer","example":"JP MORGAN CHASE","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_issuer.oneOf.0","typeLabel":"string"},{"type":"null","description":"Card Issuer","example":"JP MORGAN CHASE","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_issuer.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_issuer","typeLabel":"string | null"},"card_type":{"oneOf":[{"type":"string","description":"Funding type of the card, `credit` or `debit`, enriched from the card bin","example":"credit","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Funding type of the card, `credit` or `debit`, enriched from the card bin","example":"credit","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_type","typeLabel":"string | null"},"card_issuing_country":{"oneOf":[{"type":"string","description":"Country in which the card was issued, enriched from the card bin","example":"INDIA","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_issuing_country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country in which the card was issued, enriched from the card bin","example":"INDIA","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_issuing_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_issuing_country","typeLabel":"string | null"},"card_isin":{"oneOf":[{"type":"string","description":"Issuer identification number of the card, retained so that any further card details can\nbe looked up from it later","example":"424242","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_isin.oneOf.0","typeLabel":"string"},{"type":"null","description":"Issuer identification number of the card, retained so that any further card details can\nbe looked up from it later","example":"424242","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_isin.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value.card_isin","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details.value","typeLabel":"object"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_payment_method_details","typeLabel":"object"},"payment_connector_transmission":{"oneOf":[{"type":"string","enum":["ConnectorCallUnsuccessful","ConnectorCallSucceeded"],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.payment_connector_transmission.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.payment_connector_transmission.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.payment_connector_transmission","typeLabel":"enum\u003cstring> | null"},"billing_connector_id":{"oneOf":[{"type":"string","description":"Billing Connector Id to update the invoices. Absent when the transaction is recorded without merchant connector accounts.","example":"mca_1234567890","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Billing Connector Id to update the invoices. Absent when the transaction is recorded without merchant connector accounts.","example":"mca_1234567890","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.billing_connector_id","typeLabel":"string | null"},"active_attempt_payment_connector_id":{"oneOf":[{"type":"string","description":"Payment Connector Id to retry the payments. Absent when the transaction is recorded without merchant connector accounts.","example":"mca_1234567890","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.active_attempt_payment_connector_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Payment Connector Id to retry the payments. Absent when the transaction is recorded without merchant connector accounts.","example":"mca_1234567890","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.active_attempt_payment_connector_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.active_attempt_payment_connector_id","typeLabel":"string | null"},"invoice_next_billing_time":{"oneOf":[{"type":"string","format":"date-time","description":"Invoice Next billing time","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.invoice_next_billing_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Invoice Next billing time","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.invoice_next_billing_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.invoice_next_billing_time","typeLabel":"string\u003cdate-time> | null"},"invoice_billing_started_at_time":{"oneOf":[{"type":"string","format":"date-time","description":"Invoice Next billing time","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.invoice_billing_started_at_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Invoice Next billing time","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.invoice_billing_started_at_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.invoice_billing_started_at_time","typeLabel":"string\u003cdate-time> | null"},"first_payment_attempt_pg_error_code":{"oneOf":[{"type":"string","description":"First Payment Attempt Payment Gateway Error Code","example":"card_declined","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_pg_error_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"First Payment Attempt Payment Gateway Error Code","example":"card_declined","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_pg_error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_pg_error_code","typeLabel":"string | null"},"first_payment_attempt_network_decline_code":{"oneOf":[{"type":"string","description":"First Payment Attempt Network Error Code","example":"05","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_network_decline_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"First Payment Attempt Network Error Code","example":"05","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_network_decline_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_network_decline_code","typeLabel":"string | null"},"first_payment_attempt_network_advice_code":{"oneOf":[{"type":"string","description":"First Payment Attempt Network Advice Code","example":"02","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_network_advice_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"First Payment Attempt Network Advice Code","example":"02","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_network_advice_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.first_payment_attempt_network_advice_code","typeLabel":"string | null"},"revenue_recovery_ab_routing":{"oneOf":[{"type":"string","description":"The retry implementations available within the `Smart` arm of revenue recovery.","enum":["adaptive_retry","hybrid_adaptive_retry","systematic_k_max_at_softmax","systematic_k_max_at_score"],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.revenue_recovery_ab_routing.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.revenue_recovery_ab_routing.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0.revenue_recovery_ab_routing","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.revenue_recovery.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.revenue_recovery","typeLabel":"object | null"},"pix_additional_details":{"oneOf":[{"type":"object","required":["immediate"],"properties":{"immediate":{"type":"object","required":["time"],"properties":{"time":{"type":"integer","format":"int32","description":"Expiration time in seconds","minimum":0,"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.time","typeLabel":"integer\u003cint32>"},"pix_key":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["cpf"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.0.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["cnpj"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.2.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.2","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.3.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.3.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["evp_token"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.4.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.4.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.4","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key.oneOf.5","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate.pix_key","typeLabel":"object · object · object · object · object · null"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0.immediate","typeLabel":"object"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.0","typeLabel":"object"},{"type":"object","required":["scheduled"],"properties":{"scheduled":{"type":"object","required":["date"],"properties":{"date":{"type":"string","description":"Expiration time in terms of date, format: YYYY-MM-DD","example":"2026-07-08","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.date","typeLabel":"string"},"validity_after_expiration":{"oneOf":[{"type":"integer","format":"int32","description":"Days after expiration date for which the QR code remains valid","example":10,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.validity_after_expiration.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Days after expiration date for which the QR code remains valid","example":10,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.validity_after_expiration.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.validity_after_expiration","typeLabel":"integer\u003cint32> | null"},"pix_key":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["cpf"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.0.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["cnpj"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.2.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.2","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.3.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.3.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["evp_token"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.4.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.4.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.4","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key.oneOf.5","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled.pix_key","typeLabel":"object · object · object · object · object · null"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1.scheduled","typeLabel":"object"}},"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.1","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_additional_details.oneOf.2","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_additional_details","typeLabel":"object · object · null"},"boleto_additional_details":{"oneOf":[{"type":"object","properties":{"due_date":{"oneOf":[{"type":"string","description":"Due Date for the Boleto","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.due_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Due Date for the Boleto","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.due_date","typeLabel":"string | null"},"document_kind":{"oneOf":[{"type":"string","enum":["commercial_invoice","service_invoice","promissory_note","rural_promissory_note","receipt","insurance_policy","credit_card_invoice","proposal","deposit_or_funding","cheque","direct_promissory_note","other"],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.document_kind.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.document_kind.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.document_kind","typeLabel":"enum\u003cstring> | null"},"payment_type":{"oneOf":[{"type":"string","enum":["fixed_amount","flexible_amount","installment"],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_type","typeLabel":"enum\u003cstring> | null"},"covenant_code":{"oneOf":[{"type":"string","example":"3568253","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.covenant_code.oneOf.0","typeLabel":"string"},{"type":"null","example":"3568253","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.covenant_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.covenant_code","typeLabel":"string | null"},"pix_key":{"oneOf":[{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["cpf"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.0.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.0","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["cnpj"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.1.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.1","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.2.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.2.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.2","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.3.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.3.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.3","typeLabel":"object"},{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","enum":["evp_token"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.4.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.4.value","typeLabel":"string"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.4","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key.oneOf.5","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.pix_key","typeLabel":"object · object · object · object · object · null"},"discount_rules":{"oneOf":[{"type":"object","description":"Defines the type of discount applied to a payment, such as whether it's a fixed date discount, a daily calendar discount, or a daily business discount.","required":["tiers"],"properties":{"tiers":{"type":"array","items":{"type":"object","properties":{"amount":{"oneOf":[{"type":"string","description":"The discount value (e.g., \"5.50\").","example":"5.50","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","description":"The discount value (e.g., \"5.50\").","example":"5.50","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].amount","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","description":"The ISO-8601 date until which this discount is valid","example":"2027-12-31","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].end_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ISO-8601 date until which this discount is valid","example":"2027-12-31","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX].end_date","typeLabel":"string | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers.items.[INDEX]","typeLabel":"object"},"description":"A generic vector of discount tiers","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.tiers","typeLabel":"object[]"},"discount_type":{"oneOf":[{"type":"string","description":"Defines the type of discount applied to a payment, such as whether it's a fixed date discount, a daily calendar discount, or a daily business discount.","enum":["standard","fixed_date","daily_calendar","daily_business"],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.discount_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.discount_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0.discount_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.discount_rules","typeLabel":"object | null"},"penalties":{"oneOf":[{"type":"object","description":"Represents the rules for applying discounts to a payment, such as a percentage discount or a fixed amount discount, along with any applicable grace periods.","properties":{"fixed_penalty":{"oneOf":[{"type":"object","description":"Represents the rules for applying discounts to a payment, such as a percentage discount or a fixed amount discount, along with any applicable grace periods.","properties":{"value":{"oneOf":[{"type":"string","description":"The numeric value (as a string to preserve decimal precision)","example":"2.00","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"The numeric value (as a string to preserve decimal precision)","example":"2.00","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.value","typeLabel":"string | null"},"grace_period_days":{"oneOf":[{"type":"integer","format":"int32","description":"Grace period: Days after due date before this applies","example":1,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.grace_period_days.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Grace period: Days after due date before this applies","example":1,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.grace_period_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0.grace_period_days","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.fixed_penalty","typeLabel":"object | null"},"interest":{"oneOf":[{"type":"object","description":"Represents the rules for applying discounts to a payment, such as a percentage discount or a fixed amount discount, along with any applicable grace periods.","properties":{"interest_percentage":{"oneOf":[{"type":"string","description":"Percentage of Juros (Interest). Pattern: ^[0-9]{1,3}\\.[0-9]{2}$","example":"5.00","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0.interest_percentage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Percentage of Juros (Interest). Pattern: ^[0-9]{1,3}\\.[0-9]{2}$","example":"5.00","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0.interest_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0.interest_percentage","typeLabel":"string | null"},"iof_percentage":{"oneOf":[{"type":"string","description":"Percentage of IOF (Financial Operations Tax). Pattern: \\d{3}$\\.\\d{5}\nOnly provided if the agreement is \"Cobra IOF na Barra ou Cadastro\"","example":"32.45325","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0.iof_percentage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Percentage of IOF (Financial Operations Tax). Pattern: \\d{3}$\\.\\d{5}\nOnly provided if the agreement is \"Cobra IOF na Barra ou Cadastro\"","example":"32.45325","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0.iof_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0.iof_percentage","typeLabel":"string | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0.interest","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.penalties","typeLabel":"object | null"},"collection_actions":{"oneOf":[{"type":"object","description":"Represents the legal or administrative actions that may be taken for non-payment, such as protest rules and automatic write-off timelines.","properties":{"legal_protest":{"oneOf":[{"type":"object","required":["protest_type","days_after_due_date"],"properties":{"protest_type":{"type":"string","description":"Defines the type of protest for non-payment, such as whether the count is based on calendar days, business days, or if the protest logic is determined by a pre-signed contract with the bank.","enum":["disabled","calendar_days","business_days","contract_default"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.0.protest_type","typeLabel":"enum\u003cstring>"},"days_after_due_date":{"type":"integer","format":"int32","description":"Number of days after the due date to initiate the protest","example":30,"minimum":0,"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.0.days_after_due_date","typeLabel":"integer\u003cint32>"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.legal_protest.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.legal_protest","typeLabel":"object | null"},"auto_write_off_days":{"oneOf":[{"type":"integer","format":"int32","description":"Days after which the bill is automatically cancelled/written off","example":60,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.auto_write_off_days.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Days after which the bill is automatically cancelled/written off","example":60,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.auto_write_off_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0.auto_write_off_days","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.collection_actions","typeLabel":"object | null"},"payment_constraints":{"oneOf":[{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","required":["type"],"properties":{"type":{"type":"string","enum":["fixed_amount"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.0","typeLabel":"object"},{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","required":["type","details"],"properties":{"type":{"type":"string","enum":["flexible_amount"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.type","typeLabel":"enum\u003cstring>"},"details":{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","properties":{"min_value":{"oneOf":[{"type":"string","description":"Minimum value allowed (e.g., \"10.00\")","example":"38.02","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.min_value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Minimum value allowed (e.g., \"10.00\")","example":"38.02","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.min_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.min_value","typeLabel":"string | null"},"max_value":{"oneOf":[{"type":"string","description":"Maximum value allowed (e.g., \"5000.00\")","example":"38.02","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.max_value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Maximum value allowed (e.g., \"5000.00\")","example":"38.02","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.max_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.max_value","typeLabel":"string | null"},"value_type":{"oneOf":[{"type":"string","description":"Defines how the payment amount is calculated for penalties or discounts, either as a percentage or as a flat amount.","enum":["percentage","flat_amount"],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.value_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.value_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details.value_type","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1.details","typeLabel":"object"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.1","typeLabel":"object"},{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","required":["type","details"],"properties":{"type":{"type":"string","enum":["installment"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.type","typeLabel":"enum\u003cstring>"},"details":{"type":"object","description":"Represents the rules for legal protest (official debt registration) for non-payment, including the type of protest and the number of days after which the protest is initiated.","properties":{"max_partial_payments":{"oneOf":[{"type":"integer","format":"int32","description":"Maximum number of partial payments allowed (Up to 99 for Santander).","example":99,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details.max_partial_payments.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Maximum number of partial payments allowed (Up to 99 for Santander).","example":99,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details.max_partial_payments.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details.max_partial_payments","typeLabel":"integer\u003cint32> | null"},"value_type":{"oneOf":[{"type":"string","description":"Defines how the payment amount is calculated for penalties or discounts, either as a percentage or as a flat amount.","enum":["percentage","flat_amount"],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details.value_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details.value_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details.value_type","typeLabel":"enum\u003cstring> | null"}},"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2.details","typeLabel":"object"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints.oneOf.3","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.payment_constraints","typeLabel":"object · object · object · null"},"beneficiary":{"oneOf":[{"type":"object","description":"Represents the end-recipient of a payout or fund transfer.","properties":{"name":{"oneOf":[{"type":"string","description":"The full legal name of the individual or entity receiving the funds.","example":"João da Silva","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full legal name of the individual or entity receiving the funds.","example":"João da Silva","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.name","typeLabel":"string | null"},"document_number":{"oneOf":[{"type":"string","description":"The customer's unique identification number (e.g., Tax ID, SSN, Passport Number).\nUsed by processors to verify the identity of the recipient and prevent fraud.\nLength of the document number depends upon the document_type.\nFor CPF/CNPJ it is typically 11/14 digits long.","example":"9615865832","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.document_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The customer's unique identification number (e.g., Tax ID, SSN, Passport Number).\nUsed by processors to verify the identity of the recipient and prevent fraud.\nLength of the document number depends upon the document_type.\nFor CPF/CNPJ it is typically 11/14 digits long.","example":"9615865832","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.document_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.document_number","typeLabel":"string | null"},"document_type":{"oneOf":[{"type":"string","description":"Represents the type of identification document used for validation.","enum":["cpf","cnpj","psn","other"],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.document_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.document_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0.document_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0.beneficiary","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.boleto_additional_details","typeLabel":"object | null"},"pix_automatico_additional_details":{"oneOf":[{"type":"object","description":"Represents the specific data for Santander Pix Automatico (recurring PIX payments)\nSplit into CIT (Customer Initiated Transaction) and MIT (Merchant Initiated Transaction) variants","required":["type","time"],"properties":{"time":{"type":"integer","format":"int32","description":"Time in seconds until which the push notification is valid","example":3600,"minimum":0,"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.time","typeLabel":"integer\u003cint32>"},"type":{"type":"string","enum":["pix_automatico_push"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.type","typeLabel":"enum\u003cstring>"},"retry_policy":{"oneOf":[{"type":"boolean","description":"Enable retry policy for failed payments (maps to PERMITE_3R_7D if true)","example":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.retry_policy.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable retry policy for failed payments (maps to PERMITE_3R_7D if true)","example":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.retry_policy.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.retry_policy","typeLabel":"boolean | null"},"mandate_details":{"oneOf":[{"type":"object","properties":{"fixed_recurring_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Fixed amount for each recurring charge in minor units (e.g., cents). If not provided, the mandate will allow variable amounts.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.fixed_recurring_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Fixed amount for each recurring charge in minor units (e.g., cents). If not provided, the mandate will allow variable amounts.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.fixed_recurring_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.fixed_recurring_amount","typeLabel":"integer\u003cint64> | null"},"min_recurring_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Minimum amount for each recurring charge in minor units (e.g., cents). If not provided, there will be no minimum limit on the amount.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.min_recurring_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Minimum amount for each recurring charge in minor units (e.g., cents). If not provided, there will be no minimum limit on the amount.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.min_recurring_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.min_recurring_amount","typeLabel":"integer\u003cint64> | null"},"start_date":{"oneOf":[{"type":"string","description":"Start date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid immediately.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.start_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Start date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid immediately.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.start_date","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","description":"End date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid indefinitely.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.end_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"End date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid indefinitely.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.end_date","typeLabel":"string | null"},"periodicity":{"oneOf":[{"type":"string","enum":["weekly","monthly","quarterly","semiannually","annually"],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.periodicity.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.periodicity.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0.periodicity","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0.mandate_details","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.0","typeLabel":"object"},{"type":"object","description":"Represents the specific data for Santander Pix Automatico (recurring PIX payments)\nSplit into CIT (Customer Initiated Transaction) and MIT (Merchant Initiated Transaction) variants","required":["type"],"properties":{"type":{"type":"string","enum":["pix_automatico_qr"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.type","typeLabel":"enum\u003cstring>"},"retry_policy":{"oneOf":[{"type":"boolean","description":"Enable retry policy for failed payments (maps to PERMITE_3R_7D if true)","example":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.retry_policy.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable retry policy for failed payments (maps to PERMITE_3R_7D if true)","example":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.retry_policy.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.retry_policy","typeLabel":"boolean | null"},"mandate_details":{"oneOf":[{"type":"object","properties":{"fixed_recurring_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Fixed amount for each recurring charge in minor units (e.g., cents). If not provided, the mandate will allow variable amounts.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.fixed_recurring_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Fixed amount for each recurring charge in minor units (e.g., cents). If not provided, the mandate will allow variable amounts.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.fixed_recurring_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.fixed_recurring_amount","typeLabel":"integer\u003cint64> | null"},"min_recurring_amount":{"oneOf":[{"type":"integer","format":"int64","description":"Minimum amount for each recurring charge in minor units (e.g., cents). If not provided, there will be no minimum limit on the amount.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.min_recurring_amount.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Minimum amount for each recurring charge in minor units (e.g., cents). If not provided, there will be no minimum limit on the amount.","example":6540,"minimum":0,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.min_recurring_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.min_recurring_amount","typeLabel":"integer\u003cint64> | null"},"start_date":{"oneOf":[{"type":"string","description":"Start date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid immediately.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.start_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Start date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid immediately.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.start_date","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","description":"End date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid indefinitely.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.end_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"End date for the recurring charges. Format: YYYY-MM-DD. If not provided, the mandate will be valid indefinitely.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.end_date","typeLabel":"string | null"},"periodicity":{"oneOf":[{"type":"string","enum":["weekly","monthly","quarterly","semiannually","annually"],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.periodicity.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.periodicity.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0.periodicity","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1.mandate_details","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.1","typeLabel":"object"},{"type":"object","description":"Represents the specific data for Santander Pix Automatico (recurring PIX payments)\nSplit into CIT (Customer Initiated Transaction) and MIT (Merchant Initiated Transaction) variants","required":["type"],"properties":{"type":{"type":"string","enum":["pix_automatico_mit"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.type","typeLabel":"enum\u003cstring>"},"receiver_details":{"oneOf":[{"type":"object","description":"Represents the receiver details for Santander Pix Automatico recurring charges","properties":{"branch_code":{"oneOf":[{"type":"string","description":"Branch code (agencia) of the receiver's bank account","example":"0001","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.branch_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Branch code (agencia) of the receiver's bank account","example":"0001","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.branch_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.branch_code","typeLabel":"string | null"},"account_number":{"oneOf":[{"type":"string","description":"Account number (conta) of the receiver","example":"130333323","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.account_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Account number (conta) of the receiver","example":"130333323","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.account_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.account_number","typeLabel":"string | null"},"account_type":{"oneOf":[{"type":"string","description":"Account type for Santander Pix Automatico recurring charges","enum":["current","savings","payment"],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.account_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.account_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0.account_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.receiver_details","typeLabel":"object | null"},"mandate_execution_date":{"oneOf":[{"type":"string","description":"Execution date for the mandate charge (maps to data_de_vencimento). Format: YYYY-MM-DD.\nIf not provided, defaults to current date + 1 day.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.mandate_execution_date.oneOf.0","typeLabel":"string"},{"type":"null","description":"Execution date for the mandate charge (maps to data_de_vencimento). Format: YYYY-MM-DD.\nIf not provided, defaults to current date + 1 day.","example":"2026-12-31","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.mandate_execution_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.mandate_execution_date","typeLabel":"string | null"},"auto_adjust_date":{"oneOf":[{"type":"boolean","description":"Whether to automatically adjust the due date to the next business day if it falls on a non-business day.\nMaps to ajuste_dia_util in Santander API. Defaults to true if not provided.","example":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.auto_adjust_date.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether to automatically adjust the due date to the next business day if it falls on a non-business day.\nMaps to ajuste_dia_util in Santander API. Defaults to true if not provided.","example":true,"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.auto_adjust_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2.auto_adjust_date","typeLabel":"boolean | null"}},"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.2","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details.oneOf.3","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.pix_automatico_additional_details","typeLabel":"object · object · object · null"},"finix_additional_details":{"oneOf":[{"type":"object","properties":{"fraud_session_id":{"oneOf":[{"type":"string","description":"The fraud session ID used for Finix fraud detection","example":"1234567890abcdef","uniqueKey":"feature_metadata.oneOf.0.finix_additional_details.oneOf.0.fraud_session_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The fraud session ID used for Finix fraud detection","example":"1234567890abcdef","uniqueKey":"feature_metadata.oneOf.0.finix_additional_details.oneOf.0.fraud_session_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.finix_additional_details.oneOf.0.fraud_session_id","typeLabel":"string | null"}},"uniqueKey":"feature_metadata.oneOf.0.finix_additional_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.finix_additional_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.finix_additional_details","typeLabel":"object | null"},"multi_currency_processing":{"oneOf":[{"type":"object","description":"Datatrans multi-currency processing (multi-currency processing) details supplied by the merchant.\n\n`amount`/`currency` here describe the **merchant settlement leg** — what Planet pays out to\nthe merchant. The payment's own `amount`/`currency` remain the **customer-facing leg**, i.e.\nwhat the shopper saw at checkout and is charged. Hyperswitch never recomputes either leg; the\nmerchant is the source of truth for both.","required":["currency","amount"],"properties":{"currency":{"type":"string","description":"The three-letter ISO 4217 currency code (e.g., \"USD\", \"EUR\") for the payment amount. This field is mandatory for creating a payment.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SLL","SOS","SRD","SSP","STD","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.currency","typeLabel":"enum\u003cstring>"},"amount":{"type":"integer","format":"int64","description":"The merchant settlement amount, expressed in `currency`. The merchant converts the\ncustomer-facing amount itself and supplies the result here.","isRequired":true,"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.amount","typeLabel":"integer\u003cint64>"},"conversion_rate":{"oneOf":[{"type":"number","format":"double","description":"Conversion rate received from the currency rates endpoint. Required for dynamic multi-currency processing.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_rate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Conversion rate received from the currency rates endpoint. Required for dynamic multi-currency processing.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_rate","typeLabel":"number\u003cdouble> | null"},"date":{"oneOf":[{"type":"string","format":"date-time","description":"Transaction datetime received from the currency rates endpoint.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Transaction datetime received from the currency rates endpoint.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.date.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.date","typeLabel":"string\u003cdate-time> | null"},"processing_reference_id":{"oneOf":[{"type":"string","description":"Processing reference received from the currency rates endpoint.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.processing_reference_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Processing reference received from the currency rates endpoint.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.processing_reference_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.processing_reference_id","typeLabel":"string | null"},"user_id":{"oneOf":[{"type":"string","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.user_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.user_id","typeLabel":"string | null"},"conversion_provider":{"oneOf":[{"type":"string","description":"The provider for multi-currency processing.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"The provider for multi-currency processing.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_provider","typeLabel":"string | null"},"conversion_reason_code":{"oneOf":[{"type":"string","description":"Reason indicator received from the acquirer.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_reason_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reason indicator received from the acquirer.","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_reason_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0.conversion_reason_code","typeLabel":"string | null"}},"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata.oneOf.0.multi_currency_processing","typeLabel":"object | null"}},"uniqueKey":"feature_metadata.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"feature_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"feature_metadata","typeLabel":"object | 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://hyperswitch.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","eft_debit_order","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","neteller","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","pix_key","pix_emv","pix_qr","pix_automatico_qr","pix_automatico_push","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","wero","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","payshap","payshap_proxy","ted"],"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"},"show_merchant_name":{"oneOf":[{"type":"boolean","description":"Flag to display the merchant name in the payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.show_merchant_name.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Flag to display the merchant name in the payment link","default":true,"example":true,"uniqueKey":"payment_link_config.oneOf.0.show_merchant_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.show_merchant_name","typeLabel":"boolean | null"},"payment_methods_separator_text":{"oneOf":[{"type":"string","description":"Custom text for the separator shown between wallet and card payment method sections","example":"Or pay with","maxLength":64,"uniqueKey":"payment_link_config.oneOf.0.payment_methods_separator_text.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom text for the separator shown between wallet and card payment method sections","example":"Or pay with","maxLength":64,"uniqueKey":"payment_link_config.oneOf.0.payment_methods_separator_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.payment_methods_separator_text","typeLabel":"string | null"},"redirect_delay_seconds":{"oneOf":[{"type":"integer","format":"int32","description":"Duration in seconds before the status page auto-redirects to the return URL.\nSet to 0 to disable auto-redirect. Maximum value is 900 seconds. Defaults to 5 seconds.","example":10,"maximum":900,"minimum":0,"uniqueKey":"payment_link_config.oneOf.0.redirect_delay_seconds.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Duration in seconds before the status page auto-redirects to the return URL.\nSet to 0 to disable auto-redirect. Maximum value is 900 seconds. Defaults to 5 seconds.","example":10,"maximum":900,"minimum":0,"uniqueKey":"payment_link_config.oneOf.0.redirect_delay_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment_link_config.oneOf.0.redirect_delay_seconds","typeLabel":"integer\u003cint32> | 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"},"frm_metadata":{"oneOf":[{"type":"object","description":"Additional data related to some frm(Fraud Risk Management) connectors","uniqueKey":"frm_metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional data related to some frm(Fraud Risk Management) connectors","uniqueKey":"frm_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"frm_metadata","typeLabel":"object | null"},"enable_partial_authorization":{"oneOf":[{"type":"boolean","description":"Allow partial authorization for this payment","default":false,"uniqueKey":"enable_partial_authorization.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Allow partial authorization for this payment","default":false,"uniqueKey":"enable_partial_authorization.oneOf.1","typeLabel":"null"}],"uniqueKey":"enable_partial_authorization","typeLabel":"boolean | null"},"is_account_funded_transaction":{"oneOf":[{"type":"boolean","description":"Indicates whether this payment is an account funded transaction.","example":true,"uniqueKey":"is_account_funded_transaction.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether this payment is an account funded transaction.","example":true,"uniqueKey":"is_account_funded_transaction.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_account_funded_transaction","typeLabel":"boolean | null"},"recipient_details":{"oneOf":[{"type":"object","description":"A partially masked view of `RecipientDetails`, safe to return in API responses.","properties":{"account":{"oneOf":[{"type":"object","description":"A partially masked view of `RecipientAccount`, safe to return in API responses.","required":["type","iban","bank_account_type"],"properties":{"iban":{"type":"string","description":"The recipient's partially masked IBAN.","example":"GB29N************46864","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.0.iban","typeLabel":"string"},"bank_account_type":{"type":"string","enum":["iban"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.0.bank_account_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["bank_account"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.0","typeLabel":"object"},{"type":"object","description":"A partially masked view of `RecipientAccount`, safe to return in API responses.","required":["type","account_number","routing_number","bank_account_type"],"properties":{"account_number":{"type":"string","description":"The recipient's partially masked bank account number.","example":"0001****6789","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.1.account_number","typeLabel":"string"},"routing_number":{"type":"string","description":"The partially masked routing number of the recipient's bank.","example":"110***000","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.1.routing_number","typeLabel":"string"},"bank_account_type":{"type":"string","enum":["routing_number"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.1.bank_account_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["bank_account"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.1","typeLabel":"object"},{"type":"object","description":"A partially masked view of `RecipientAccount`, safe to return in API responses.","required":["type","account_number","bic","bank_account_type"],"properties":{"account_number":{"type":"string","description":"The recipient's partially masked bank account number.","example":"0987****5432","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.2.account_number","typeLabel":"string"},"bic":{"type":"string","description":"The partially masked Bank Identification Code of the recipient's bank.","example":"HBU***4B","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.2.bic","typeLabel":"string"},"bank_account_type":{"type":"string","enum":["bic"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.2.bank_account_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["bank_account"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.2","typeLabel":"object"},{"type":"object","description":"A partially masked view of `RecipientAccount`, safe to return in API responses.","required":["type","account_number","bank_account_type"],"properties":{"account_number":{"type":"string","description":"The recipient's partially masked bank account number.","example":"0001****6789","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.3.account_number","typeLabel":"string"},"bank_account_type":{"type":"string","enum":["account_number"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.3.bank_account_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["bank_account"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.3.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.3","typeLabel":"object"},{"type":"object","description":"A partially masked view of `RecipientAccount`, safe to return in API responses.","required":["type","card_isin","last4","bank_account_type"],"properties":{"card_isin":{"type":"string","description":"The first six digits of the recipient's PAN.","example":"411111","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.4.card_isin","typeLabel":"string"},"last4":{"type":"string","description":"The last four digits of the recipient's PAN.","example":"1111","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.4.last4","typeLabel":"string"},"bank_account_type":{"type":"string","enum":["truncated_pan"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.4.bank_account_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["bank_account"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.4.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.4","typeLabel":"object"},{"type":"object","description":"A partially masked view of `RecipientAccount`, safe to return in API responses.","required":["card_number","type"],"properties":{"card_number":{"type":"string","description":"The recipient's partially masked card number.","example":"411111******1111","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.5.card_number","typeLabel":"string"},"type":{"type":"string","enum":["card"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.5.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.5","typeLabel":"object"},{"type":"object","description":"A partially masked view of `RecipientAccount`, safe to return in API responses.","required":["wallet_id","type"],"properties":{"wallet_id":{"type":"string","description":"The partially masked identifier of the recipient's wallet.","example":"wall****8891","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.6.wallet_id","typeLabel":"string"},"type":{"type":"string","enum":["wallet"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.6.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.6","typeLabel":"object"},{"type":"object","description":"A partially masked view of `RecipientAccount`, safe to return in API responses.","required":["email","type"],"properties":{"email":{"type":"string","description":"The email address that identifies the recipient's account.","example":"ja******@example.com","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.7.email","typeLabel":"string"},"type":{"type":"string","enum":["email"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.7.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.7","typeLabel":"object"},{"type":"object","description":"A partially masked view of `RecipientAccount`, safe to return in API responses.","required":["phone_number","type"],"properties":{"phone_number":{"type":"string","description":"The phone number that identifies the recipient's account.","example":"9123****6789","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.8.phone_number","typeLabel":"string"},"type":{"type":"string","enum":["phone"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.8.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.8","typeLabel":"object"},{"type":"object","description":"A partially masked view of `RecipientAccount`, safe to return in API responses.","required":["social_network_id","type"],"properties":{"social_network_id":{"type":"string","description":"The social network identifier of the recipient.","example":"jane****.doe","isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.9.social_network_id","typeLabel":"string"},"type":{"type":"string","enum":["social_network"],"isRequired":true,"uniqueKey":"recipient_details.oneOf.0.account.oneOf.9.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recipient_details.oneOf.0.account.oneOf.9","typeLabel":"object"},{"type":"null","uniqueKey":"recipient_details.oneOf.0.account.oneOf.10","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.account","typeLabel":"object · object · object · object · object · object · object · object · object · object · null"},"phone_number":{"oneOf":[{"type":"string","description":"The recipient's partially masked phone number.","example":"9123****6789","uniqueKey":"recipient_details.oneOf.0.phone_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The recipient's partially masked phone number.","example":"9123****6789","uniqueKey":"recipient_details.oneOf.0.phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.phone_number","typeLabel":"string | null"},"tax_id":{"oneOf":[{"type":"string","description":"The recipient's partially masked tax identifier.","example":"162.****41-42","uniqueKey":"recipient_details.oneOf.0.tax_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The recipient's partially masked tax identifier.","example":"162.****41-42","uniqueKey":"recipient_details.oneOf.0.tax_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.tax_id","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","description":"Address details","properties":{"city":{"oneOf":[{"type":"string","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"The city, district, suburb, town, or village of the address.","example":"New York","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW","US"],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.country","typeLabel":"enum\u003cstring> | null"},"line1":{"oneOf":[{"type":"string","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first line of the street address or P.O. Box.","example":"123, King Street","maxLength":200,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building).","example":"Powelson Avenue","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line2","typeLabel":"string | null"},"line3":{"oneOf":[{"type":"string","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line3.oneOf.0","typeLabel":"string"},{"type":"null","description":"The third line of the street address, if applicable.","example":"Bridgewater","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line3.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.line3","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code for the address","example":"08807","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.zip","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The address state","example":"New York","uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The address state","example":"New York","uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.state","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The first name for the address","example":"John","maxLength":255,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The last name for the address","example":"Doe","maxLength":255,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.last_name","typeLabel":"string | null"},"origin_zip":{"oneOf":[{"type":"string","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.origin_zip.oneOf.0","typeLabel":"string"},{"type":"null","description":"The zip/postal code of the origin","example":"08807","maxLength":50,"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.origin_zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0.origin_zip","typeLabel":"string | null"}},"uniqueKey":"recipient_details.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"recipient_details.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details.oneOf.0.address","typeLabel":"object | null"}},"uniqueKey":"recipient_details.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"recipient_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"recipient_details","typeLabel":"object | null"},"enable_avs_check":{"oneOf":[{"type":"boolean","description":"Whether address verification was requested for this payment.","example":true,"uniqueKey":"enable_avs_check.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether address verification was requested for this payment.","example":true,"uniqueKey":"enable_avs_check.oneOf.1","typeLabel":"null"}],"uniqueKey":"enable_avs_check","typeLabel":"boolean | null"},"enable_account_name_verification":{"oneOf":[{"type":"boolean","description":"Whether account name verification was requested for this payment.","example":true,"uniqueKey":"enable_account_name_verification.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether account name verification was requested for this payment.","example":true,"uniqueKey":"enable_account_name_verification.oneOf.1","typeLabel":"null"}],"uniqueKey":"enable_account_name_verification","typeLabel":"boolean | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","status":"succeeded","amount_details":{"order_amount":6540,"currency":"AED","external_tax_calculation":"skip","surcharge_calculation":"skip","shipping_cost":123,"order_tax_amount":123,"surcharge_amount":123,"tax_on_surcharge":123,"amount_captured":123},"client_secret":"cs_0195b34da95d75239c6a4bf514458896","profile_id":"\u003cstring>","capture_method":"automatic","customer_id":"0a_cus_01926c58bc6e77c09e809964e72af8c8","customer_present":"present","setup_future_usage":"off_session","apply_mit_exemption":"Apply","payment_link_enabled":"Enable","request_incremental_authorization":"true","split_txns_enabled":"skip","expires_on":"2023-11-07T05:31:56Z","request_external_three_ds_authentication":"Enable","payment_type":"normal","merchant_reference_id":"pay_mbabizu24mvu3mela5njyhpit4","routing_algorithm_id":"\u003cstring>","authentication_type":"three_ds","billing":{"address":{"city":"New York","country":"AF","line1":"123, King Street","line2":"Powelson Avenue","line3":"Bridgewater","zip":"08807","state":"New York","first_name":"John","last_name":"Doe","origin_zip":"08807"},"phone":{"number":"9123456789","country_code":"+1"},"email":"\u003cstring>"},"shipping":{"address":{"city":"New York","country":"AF","line1":"123, King Street","line2":"Powelson Avenue","line3":"Bridgewater","zip":"08807","state":"New York","first_name":"John","last_name":"Doe","origin_zip":"08807"},"phone":{"number":"9123456789","country_code":"+1"},"email":"\u003cstring>"},"description":"It's my first payment request","return_url":"https://hyperswitch.io","statement_descriptor":"Hyperswitch Router","order_details":"[{\n \"product_name\": \"Apple iPhone 16\",\n \"quantity\": 1,\n \"amount\" : 69000\n \"product_img_link\" : \"https://dummy-img-link.com\"\n }]","allowed_payment_method_types":["ach"],"metadata":{},"connector_metadata":{"apple_pay":{"session_token_data":{"payment_processing_certificate":"\u003cstring>","payment_processing_certificate_key":"\u003cstring>","payment_processing_details_at":"Hyperswitch","certificate":"\u003cstring>","certificate_keys":"\u003cstring>","merchant_identifier":"\u003cstring>","display_name":"\u003cstring>","initiative":"web","initiative_context":"\u003cstring>","merchant_business_country":"AF","payment_processing_detail_input_type":"raw"}},"airwallex":{"payload":"\u003cstring>"},"noon":{"order_category":"\u003cstring>"},"braintree":{"merchant_account_id":"\u003cstring>","merchant_config_currency":"\u003cstring>"},"adyen":{"testing":{"holder_name":"\u003cstring>"}},"peachpayments":{"rrn":"\u003cstring>","card_on_file_transaction_type":"one_off"},"santander":{"boleto":{"discount_rules":{"tiers":[{"amount":"5.50","end_date":"2027-12-31"}],"discount_type":"standard"},"penalties":{"fixed_penalty":{"value":"2.00","grace_period_days":1},"interest":{"interest_percentage":"5.00","iof_percentage":"32.45325"}},"collection_actions":{"legal_protest":{"protest_type":"disabled","days_after_due_date":30},"auto_write_off_days":60},"payment_constraints":{"type":"fixed_amount"},"beneficiary":{"name":"João da Silva","document_number":"9615865832","document_type":"cpf"},"document_kind":"commercial_invoice"}},"paypal":{"paypal_client_metadata_id":"\u003cstring>"},"worldpayxml":{"funding_transaction_type":"credit_card_bill_repayment","payment_purpose":"family_support"},"checkout":{"purpose_of_payment":"wallet top-up"},"stripe":{"error_on_requires_action":true}},"feature_metadata":{"redirect_response":{"param":"\u003cstring>","json_payload":{}},"search_tags":["\u003cstring>"],"apple_pay_recurring_details":{"payment_description":"\u003cstring>","regular_billing":{"label":"\u003cstring>","recurring_payment_start_date":"2023-09-10T23:59:59Z","recurring_payment_end_date":"2023-09-10T23:59:59Z","recurring_payment_interval_unit":"year","recurring_payment_interval_count":123},"management_url":"https://hyperswitch.io","billing_agreement":"\u003cstring>"},"revenue_recovery":{"total_retry_count":"1","billing_connector_payment_details":{"payment_processor_token":"\u003cstring>","connector_customer_id":"\u003cstring>"},"payment_method_type":"card","payment_method_subtype":"ach","connector":"absa_sanlam","billing_connector_payment_method_details":{"type":"card","value":{"card_network":"Visa","card_issuer":"JP MORGAN CHASE","card_type":"credit","card_issuing_country":"INDIA","card_isin":"424242"}},"payment_connector_transmission":"ConnectorCallUnsuccessful","billing_connector_id":"mca_1234567890","active_attempt_payment_connector_id":"mca_1234567890","invoice_next_billing_time":"2023-11-07T05:31:56Z","invoice_billing_started_at_time":"2023-11-07T05:31:56Z","first_payment_attempt_pg_error_code":"card_declined","first_payment_attempt_network_decline_code":"05","first_payment_attempt_network_advice_code":"02","revenue_recovery_ab_routing":"adaptive_retry"},"pix_additional_details":{"immediate":{"time":1,"pix_key":{"type":"cpf","value":"\u003cstring>"}}},"boleto_additional_details":{"due_date":"2026-12-31","document_kind":"commercial_invoice","payment_type":"fixed_amount","covenant_code":"3568253","pix_key":{"type":"cpf","value":"\u003cstring>"},"discount_rules":{"tiers":[{"amount":"5.50","end_date":"2027-12-31"}],"discount_type":"standard"},"penalties":{"fixed_penalty":{"value":"2.00","grace_period_days":1},"interest":{"interest_percentage":"5.00","iof_percentage":"32.45325"}},"collection_actions":{"legal_protest":{"protest_type":"disabled","days_after_due_date":30},"auto_write_off_days":60},"payment_constraints":{"type":"fixed_amount"},"beneficiary":{"name":"João da Silva","document_number":"9615865832","document_type":"cpf"}},"pix_automatico_additional_details":{"time":3600,"type":"pix_automatico_push","retry_policy":true,"mandate_details":{"fixed_recurring_amount":6540,"min_recurring_amount":6540,"start_date":"2026-12-31","end_date":"2026-12-31","periodicity":"weekly"}},"finix_additional_details":{"fraud_session_id":"1234567890abcdef"},"multi_currency_processing":{"currency":"AED","amount":123,"conversion_rate":123,"date":"2023-11-07T05:31:56Z","processing_reference_id":"\u003cstring>","user_id":"\u003cstring>","conversion_provider":"\u003cstring>","conversion_reason_code":"\u003cstring>"}},"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://hyperswitch.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>","show_merchant_name":true,"payment_methods_separator_text":"Or pay with","redirect_delay_seconds":10},"frm_metadata":{},"enable_partial_authorization":false,"is_account_funded_transaction":true,"recipient_details":{"account":{"iban":"GB29N************46864","bank_account_type":"iban","type":"bank_account"},"phone_number":"9123****6789","tax_id":"162.****41-42","address":{"city":"New York","country":"AF","line1":"123, King Street","line2":"Powelson Avenue","line3":"Bridgewater","zip":"08807","state":"New York","first_name":"John","last_name":"Doe","origin_zip":"08807"}},"enable_avs_check":true,"enable_account_name_verification":true}}},"exampleType":"generated"}},"exampleType":"generated"},"3c74d1a2-9205-45f9-b960-211f8a116b0c":{"description":"Payment Intent Not Found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"b24a3a4c-f428-4f17-bd16-5a0786485fdc":{"api_key":{"type":"apiKey","in":"header","name":"Authorization","description":"Format: `api-key=\u003capi_key>`\n\nUse the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","scopes":[],"schemeName":"api_key"}}},"servers":{"cd155929-0a18-4604-91f3-c5456ffab5c8":{"url":"https://sandbox.hyperswitch.io","description":"Sandbox Environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Format: `api-key=\u003capi_key>`\n\nUse the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","scopes":[],"schemeName":"api_key"},"schema":{"title":"Authorization","type":"string","description":"Format: `api-key=\u003capi_key>`\n\nUse the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"Authorization"}],"title":"api_key"}]},"originalFileLocation":"v2/openapi_spec_v2.json"},"subdomain":"juspay-78","siteName":"Hyperswitch","title":"Payments - Update Intent - Hyperswitch","navMaps":{"firstHrefInVersion":{"1.0.0":{"href":"/introduction","matchLevel":3},"2.0.0":{"href":"/v2/payments/payments--update-intent","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T04:55:59.505Z","originalFileLocation":"v2/payments/payments--update-intent.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 a payment intent object You will require the \u0026#x27;API - Key\u0026#x27; from the Hyperswitch dashboard to make the call.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperswitch\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_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/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Payments - Update Intent - Hyperswitch\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a payment intent object You will require the \u0026#x27;API - Key\u0026#x27; from the Hyperswitch dashboard to make the call.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperswitch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api-reference.hyperswitch.io/v2/payments/payments--update-intent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://juspay-78.mintlify.site/_mintlify/api/og/v2?division=Payments\u0026amp;title=Payments+-+Update+Intent\u0026amp;description=**Update+a+payment+intent+object**%0A%0AYou+will+require+the+%27API+-+Key%27+from+the+Hyperswitch+dashboard+to+make+the+call.\u0026amp;theme=04960c3cf57346633e90bf0d\u0026amp;signature=913c98a5e0e0d50b4f52f89d15c5270cac0ae6a5d299cad51e10ad34da66d28c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Payments - Update Intent - Hyperswitch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a payment intent object You will require the \u0026#x27;API - Key\u0026#x27; from the Hyperswitch dashboard to make the call.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://juspay-78.mintlify.site/_mintlify/api/og/v2?division=Payments\u0026amp;title=Payments+-+Update+Intent\u0026amp;description=**Update+a+payment+intent+object**%0A%0AYou+will+require+the+%27API+-+Key%27+from+the+Hyperswitch+dashboard+to+make+the+call.\u0026amp;theme=04960c3cf57346633e90bf0d\u0026amp;signature=913c98a5e0e0d50b4f52f89d15c5270cac0ae6a5d299cad51e10ad34da66d28c\">\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/juspay-78/qt73Hm6Kezxnik3v/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperswitch\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F8EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://api-reference.hyperswitch.io/v2/payments/payments--update-intent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/payments/payments--update-intent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://api-reference.hyperswitch.io/#organization\",\"name\":\"Hyperswitch\",\"url\":\"https://api-reference.hyperswitch.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/juspay-78/Ofakw17OkkP9DV40/logo/light.svg?fit=max\u0026auto=format\u0026n=Ofakw17OkkP9DV40\u0026q=85\u0026s=c8a8a5613621b7f19e447e754f4a4ffa\"}},{\"@type\":\"WebSite\",\"@id\":\"https://api-reference.hyperswitch.io#website\",\"name\":\"Hyperswitch\",\"url\":\"https://api-reference.hyperswitch.io\",\"publisher\":{\"@id\":\"https://api-reference.hyperswitch.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://api-reference.hyperswitch.io/v2/payments/payments--update-intent#webpage\",\"url\":\"https://api-reference.hyperswitch.io/v2/payments/payments--update-intent\",\"name\":\"Payments - Update Intent\",\"description\":\"Update a payment intent object You will require the 'API - Key' from the Hyperswitch dashboard to make the call.\",\"dateModified\":\"2026-01-28T04:55:59.505Z\",\"isPartOf\":{\"@id\":\"https://api-reference.hyperswitch.io#website\"},\"breadcrumb\":{\"@id\":\"https://api-reference.hyperswitch.io/v2/payments/payments--update-intent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api-reference.hyperswitch.io/v2/payments/payments--update-intent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments Core APIs [BETA]\",\"item\":\"https://api-reference.hyperswitch.io/v2/payments/payments--create-intent\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Payments\",\"item\":\"https://api-reference.hyperswitch.io/v2/payments/payments--create-intent\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Payments - Update Intent\",\"item\":\"https://api-reference.hyperswitch.io/v2/payments/payments--update-intent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api-reference.hyperswitch.io/v2/payments/payments--update-intent#apireference\",\"headline\":\"Payments - Update Intent\",\"name\":\"Payments - Update Intent\",\"description\":\"Update a payment intent object You will require the 'API - Key' from the Hyperswitch dashboard to make the call.\",\"url\":\"https://api-reference.hyperswitch.io/v2/payments/payments--update-intent\",\"mainEntityOfPage\":{\"@id\":\"https://api-reference.hyperswitch.io/v2/payments/payments--update-intent#webpage\"},\"dateModified\":\"2026-01-28T04:55:59.505Z\",\"publisher\":{\"@id\":\"https://api-reference.hyperswitch.io/#organization\"},\"isPartOf\":{\"@id\":\"https://api-reference.hyperswitch.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperswitch\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hyperswitch\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/v2/payments/payments--update-intent.md","siteName":"Hyperswitch","nav":{"global":null,"tabs":[{"tab":"Documentation","versions":[{"version":"1.0.0","pages":[{"title":"1.0.0","href":"/introduction"}]},{"version":"2.0.0","groups":[{"group":"Get Started [BETA]","pages":[{"title":"👋 Welcome to Hyperswitch API Reference","sidebarTitle":"Introduction","icon":"rectangle-code","iconType":"solid","href":"/introduction"}]},{"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","description":"**Get a payment intent object when id is passed in path**\n\nYou will require the 'API - Key' from the Hyperswitch dashboard to make the call.","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","description":"Creates a session object or a session token for wallets like Apple Pay, Google Pay, etc. These tokens are used by Hyperswitch's SDK to initiate these wallets' SDK.","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":"put /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":"get /v2/customers/reference/{merchant_reference_id}","title":"Customers - Retrieve using Merchant Reference ID","href":"/v2/customers/customers--retrieve-by-merchant-reference-id"},{"openapi":"put /v2/customers/{id}","title":"Customers - Update","href":"/v2/customers/customers--update"},{"openapi":"delete /v2/customers/{id}","title":"Customers - Delete","href":"/v2/customers/customers--delete"},{"openapi":"get /v2/customers/list","title":"Customers - List","href":"/v2/customers/customers--list"}]},{"group":"Refunds","pages":[{"openapi":"post /v2/refunds","title":"Refunds - Create","href":"/v2/refunds/refunds--create"},{"openapi":"put /v2/refunds/{id}/update_metadata","title":null,"href":"/v2/refunds/refunds--metadata-update"},{"openapi":"get /v2/refunds/{id}","title":"Refunds - Retrieve","href":"/v2/refunds/refunds--retrieve"},{"openapi":"post /v2/refunds/list","title":"Refunds - List","href":"/v2/refunds/refunds--list"}]}]},{"group":"Account management APIs [BETA]","pages":[{"group":"Organization","pages":[{"openapi":"post /v2/organizations","title":"Organization - Create","href":"/v2/organization/organization--create"},{"openapi":"get /v2/organizations/{id}","title":"Organization - Retrieve","href":"/v2/organization/organization--retrieve"},{"openapi":"put /v2/organizations/{id}","title":"Organization - Update","href":"/v2/organization/organization--update"},{"openapi":"get /v2/organizations/{id}/merchant-accounts","title":"Organization - Merchant Account - List","href":"/v2/organization/organization--merchant-account--list"}]},{"group":"Merchant Account","pages":[{"openapi":"post /v2/merchant-accounts","title":"Merchant Account - Create","href":"/v2/merchant-account/merchant-account--create"},{"openapi":"get /v2/merchant-accounts/{id}","title":"Merchant Account - Retrieve","href":"/v2/merchant-account/merchant-account--retrieve"},{"openapi":"put /v2/merchant-accounts/{id}","title":"Merchant Account - Update","href":"/v2/merchant-account/merchant-account--update"},{"openapi":"get /v2/merchant-accounts/{id}/profiles","title":"Merchant Account - Profile List","href":"/v2/merchant-account/business-profile--list"}]},{"group":"Profile","pages":[{"openapi":"post /v2/profiles","title":"Profile - Create","href":"/v2/profile/profile--create"},{"openapi":"put /v2/profiles/{id}","title":"Profile - Update","href":"/v2/profile/profile--update"},{"openapi":"patch /v2/profiles/{id}/activate-routing-algorithm","title":"Profile - Activate routing algorithm","href":"/v2/profile/profile--activate-routing-algorithm"},{"openapi":"patch /v2/profiles/{id}/fallback-routing","title":"Profile - Update Default Fallback Routing Algorithm","href":"/v2/profile/profile--update-default-fallback-routing-algorithm"},{"openapi":"patch /v2/profiles/{id}/deactivate-routing-algorithm","title":"Profile - Deactivate routing algorithm","href":"/v2/profile/profile--deactivate-routing-algorithm"},{"openapi":"get /v2/profiles/{id}","title":"Profile - Retrieve","href":"/v2/profile/profile--retrieve"},{"openapi":"get /v2/profiles/{id}/connector-accounts","title":"Profile - Connector Accounts List","href":"/v2/profile/merchant-connector--list"},{"openapi":"get /v2/profiles/{id}/routing-algorithm","title":"Profile - Retrieve Active Routing Algorithm","href":"/v2/profile/profile--retrieve-active-routing-algorithm"},{"openapi":"get /v2/profiles/{id}/fallback-routing","title":"Profile - Retrieve Default Fallback Routing Algorithm","href":"/v2/profile/profile--retrieve-default-fallback-routing-algorithm"}]},{"group":"Connector Account","pages":[{"openapi":"post /v2/connector-accounts","title":"Connector Account - Create","href":"/v2/connector-account/connector-account--create"},{"openapi":"get /v2/connector-accounts/{id}","title":"Connector Account - Retrieve","href":"/v2/connector-account/connector-account--retrieve"},{"openapi":"put /v2/connector-accounts/{id}","title":"Connector Account - Update","href":"/v2/connector-account/connector-account--update"}]},{"group":"API Key","pages":[{"openapi":"post /v2/api-keys","title":"API Key - Create","href":"/v2/api-key/api-key--create"},{"openapi":"get /v2/api-keys/{id}","title":"API Key - Retrieve","href":"/v2/api-key/api-key--retrieve"},{"openapi":"put /v2/api-keys/{id}","title":"API Key - Update","href":"/v2/api-key/api-key--update"},{"openapi":"delete /v2/api-keys/{id}","title":"API Key - Revoke","href":"/v2/api-key/api-key--revoke"},{"openapi":"get /v2/api-keys/list","title":"API Key - List","href":"/v2/api-key/api-key--list"}]},{"group":"Routing","pages":[{"openapi":"post /v2/routing-algorithms","title":"Routing - Create","href":"/v2/routing/routing--create"},{"openapi":"get /v2/routing-algorithms/{id}","title":"Routing - Retrieve","href":"/v2/routing/routing--retrieve"}]}]},{"group":"Other APIs [BETA]","pages":[{"group":"Proxy","pages":[{"openapi":"post /v2/proxy","title":"Proxy","href":"/v2/proxy/proxy"}]},{"group":"Tokenization","pages":[{"openapi":"post /v2/tokenize","title":"Tokenization - Create","href":"/v2/tokenization/tokenization--create"}]},{"group":"Schemas","pages":[{"title":null,"href":"/v2/schemas/outgoing--webhook"}]}]},{"group":"Revenue Recovery","pages":[{"openapi":"post /v2/recovery","title":"Revenue Recovery - Create","href":"/v2/revenue-recovery/revenue-recovery--create"},{"openapi":"post /v2/recovery/{merchant_reference_id}/cancel","title":"Revenue Recovery - Cancel","href":"/v2/revenue-recovery/revenue-recovery--cancel"}]}]}]},{"tab":"Locker API Reference","pages":[{"title":"Locker API Reference","href":"/locker-api-reference/overview"}]},{"tab":"Decision Engine API Reference","pages":[{"title":"Decision Engine API Reference","href":"/decision-engine-api-reference/introduction"}]}]},"basePath":"","title":"Payments - Update Intent - Hyperswitch","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}