Performs a payment authorization using a previously stored payment method, referenced by its unique ID.
The funds are held on the customer’s account but not captured immediately.
This endpoint is typically used in multi-step checkout flows, bookings, or delayed fulfillment scenarios.
It improves security and UX by leveraging saved payment methods, eliminating the need to re-enter payment data.
The merchant's storefront or e-commerce platform URL or domain from which the transaction originates. If provided, this value will be sent to the processor (TSYS only) as the Acceptor URL Address. If not provided, the value configured in Merchant Details (E-Commerce Platform URL) will be used. If neither is available, the request is sent to TSYS without the Acceptor URL Address.
Report Groups could be used to separate your transactions into different categories, so you can view the financial reports by your specific report group names (Worldpay only).
The identifier returned for Visa, Mastercard, and Discover transactions. Visa and Discover use this value to link subsequent payments in a recurring/installment stream back to the initial transaction.
You must include this value in the request message (originalNetworkTransactionId element) for subsequent recurring payments.
Conditional. The value is returned if includeRawProcessorResponse = true.
This field contains the raw data received from the processor after attempting to bill this payment. It does not contain any sensitive information. The field value is a string with the serialized response from the processor in JSON format.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Introduction \u0026 Quick Start","colors":{"primary":"#0070e0","light":"#0070e0","dark":"#0070e0"},"logo":{"light":"https://mintcdn.com/revolv3/Zevkr_Aqagg8mPcq/logo/normallogo.png?fit=max\u0026auto=format\u0026n=Zevkr_Aqagg8mPcq\u0026q=85\u0026s=fd4c62503540a031e3c6c968fad23f13","dark":"https://mintcdn.com/revolv3/dVOZNq0ooDKRts06/logo/darklogo.png?fit=max\u0026auto=format\u0026n=dVOZNq0ooDKRts06\u0026q=85\u0026s=fcf27915d3b41117f9ebeabfe6198322"},"favicon":"https://mintcdn.com/revolv3/UvfMtv_6fKeEgTof/e9ea213-favicon.svg?fit=max\u0026auto=format\u0026n=UvfMtv_6fKeEgTof\u0026q=85\u0026s=a6a23b31eb7fe0a95654625f1d3461b7","api":{"playground":{"display":"interactive"}},"seo":{"metatags":{"canonical":"https://docs.revolv3.com"}},"integrations":{"telemetry":{"enabled":true}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"revolv3","hasAudioNarration":false,"actualSubdomain":"revolv3","customDomains":["docs.revolv3.com"],"gitSource":{"type":"github","owner":"revolv3-dev","repo":"mintlify-revolv3-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae37d43bf26c43eb731973f","collectionId":"8de06812-a1bb-43f6-8c11-51e69eb972f5","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae37d43bf26c43eb731973f"},"feedback":{"edits":true,"issues":true,"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae37d43bf26c43eb731973f","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Guides","count":46},{"language":"default","tag":"API Reference","count":43},{"language":"default","tag":"Core Concepts \u0026 Data Models","count":14},{"language":"default","tag":"Integration Flows","count":10},{"language":"default","tag":"Customers","count":10},{"language":"default","tag":"Subscriptions","count":10},{"language":"default","tag":"Payment Method","count":6},{"language":"default","tag":"PaymentMethod","count":6},{"language":"default","tag":"Payments","count":6},{"language":"default","tag":"Invoice","count":5}]},"assistantConfig":{"enableAskAiButton":true,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/payments/authorize-with-payment-method-id","slug":"/api-reference/payments/authorize-with-payment-method-id","pageMetadata":{"title":"Authorize With Payment Method Id","description":"Performs a **payment authorization** using a previously stored payment method, referenced by its unique ID.\r\nThe funds are held on the customer’s account but **not captured** immediately.\r\n\r\nThis endpoint is typically used in multi-step checkout flows, bookings, or delayed fulfillment scenarios.\r\nIt improves security and UX by leveraging saved payment methods, eliminating the need to re-enter payment data.\r\n\r\nThe authorization can later be captured using the \u003ca href=\"/api-reference/payments/capture\">Capture\u003c/a> endpoint or voided via \u003ca href=\"/api-reference/paymentmethod/reverse-authorization\">Reverse Authorization\u003c/a>.\r\n\r\nRelated Links:\r\n\u003cul>\r\n\u003cli>\u003ca href=\"/docs/core-concepts/invoice/network-processing-types\">Network Processing Types\u003c/a>\u003c/li>\r\n\u003cli>\u003ca href=\"/docs/core-concepts/invoice/dynamic-descriptor-guide\">Dynamic Descriptor Guide\u003c/a>\u003c/li>\r\n\u003cli>\u003ca href=\"/docs/core-concepts/merchants/order-processing-channels\">Order Processing Channel\u003c/a>\u003c/li>\r\n\u003c/ul>","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/authorization/{paymentMethodId}","href":"/api-reference/payments/authorize-with-payment-method-id","autogeneratedByOpenApi":true},"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: [_jsxs(_components.p, {\n children: [\"Performs a \", _jsx(_components.strong, {\n children: \"payment authorization\"\n }), \" using a previously stored payment method, referenced by its unique ID.\\r\\nThe funds are held on the customer’s account but \", _jsx(_components.strong, {\n children: \"not captured\"\n }), \" immediately.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"This endpoint is typically used in multi-step checkout flows, bookings, or delayed fulfillment scenarios.\\r\\nIt improves security and UX by leveraging saved payment methods, eliminating the need to re-enter payment data.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The authorization can later be captured using the \", _jsx(\"a\", {\n href: \"/api-reference/payments/capture\",\n children: \"Capture\"\n }), \" endpoint or voided via \", _jsx(\"a\", {\n href: \"/api-reference/paymentmethod/reverse-authorization\",\n children: \"Reverse Authorization\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Related Links:\"\n }), \"\\n\", _jsxs(\"ul\", {\n children: [_jsx(\"li\", {\n children: _jsx(\"a\", {\n href: \"/docs/core-concepts/invoice/network-processing-types\",\n children: \"Network Processing Types\"\n })\n }), _jsx(\"li\", {\n children: _jsx(\"a\", {\n href: \"/docs/core-concepts/invoice/dynamic-descriptor-guide\",\n children: \"Dynamic Descriptor Guide\"\n })\n }), _jsx(\"li\", {\n children: _jsx(\"a\", {\n href: \"/docs/core-concepts/merchants/order-processing-channels\",\n children: \"Order Processing Channel\"\n })\n })]\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":{"title":"Authorize With Payment Method Id","description":"Performs a **payment authorization** using a previously stored payment method, referenced by its unique ID.\r\nThe funds are held on the customer’s account but **not captured** immediately.\r\n\r\nThis endpoint is typically used in multi-step checkout flows, bookings, or delayed fulfillment scenarios.\r\nIt improves security and UX by leveraging saved payment methods, eliminating the need to re-enter payment data.\r\n\r\nThe authorization can later be captured using the \u003ca href=\"/api-reference/payments/capture\">Capture\u003c/a> endpoint or voided via \u003ca href=\"/api-reference/paymentmethod/reverse-authorization\">Reverse Authorization\u003c/a>.\r\n\r\nRelated Links:\r\n\u003cul>\r\n\u003cli>\u003ca href=\"/docs/core-concepts/invoice/network-processing-types\">Network Processing Types\u003c/a>\u003c/li>\r\n\u003cli>\u003ca href=\"/docs/core-concepts/invoice/dynamic-descriptor-guide\">Dynamic Descriptor Guide\u003c/a>\u003c/li>\r\n\u003cli>\u003ca href=\"/docs/core-concepts/merchants/order-processing-channels\">Order Processing Channel\u003c/a>\u003c/li>\r\n\u003c/ul>","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/authorization/{paymentMethodId}","href":"/api-reference/payments/authorize-with-payment-method-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/revolv3/b2e6669526e8a41b/scripts/fix-swagger-auth.js"],"openApiReferenceData":{"operation":{"tags":["Payments"],"summary":"Authorize With Payment Method Id","description":"Performs a **payment authorization** using a previously stored payment method, referenced by its unique ID.\r\nThe funds are held on the customer’s account but **not captured** immediately.\r\n\r\nThis endpoint is typically used in multi-step checkout flows, bookings, or delayed fulfillment scenarios.\r\nIt improves security and UX by leveraging saved payment methods, eliminating the need to re-enter payment data.\r\n\r\nThe authorization can later be captured using the \u003ca href=\"/api-reference/payments/capture\">Capture\u003c/a> endpoint or voided via \u003ca href=\"/api-reference/paymentmethod/reverse-authorization\">Reverse Authorization\u003c/a>.\r\n\r\nRelated Links:\r\n\u003cul>\r\n\u003cli>\u003ca href=\"/docs/core-concepts/invoice/network-processing-types\">Network Processing Types\u003c/a>\u003c/li>\r\n\u003cli>\u003ca href=\"/docs/core-concepts/invoice/dynamic-descriptor-guide\">Dynamic Descriptor Guide\u003c/a>\u003c/li>\r\n\u003cli>\u003ca href=\"/docs/core-concepts/merchants/order-processing-channels\">Order Processing Channel\u003c/a>\u003c/li>\r\n\u003c/ul>","parameters":["08161cf5-4106-45c7-b538-9517468f7262"],"requestBody":"69f45ebe-5a22-4ddf-85b4-a299eccb0c8e","responses":{"200":"d85b4900-5bf4-43aa-a734-d4e02ce62dcc","400":"c33f8024-3705-45d6-822d-2a35fb8336ca","401":"a99bbbbe-3daa-4e48-8679-a2c6d75b8aaa","422":"3fab48df-d8a6-497c-af54-e3edde4a7646"},"security":["095935e6-3511-40c7-a652-3d9cc8350703"],"method":"post","type":"path","servers":["334e6eb5-634d-46b6-90d2-b0f4797cf87a"],"path":"/api/Payments/authorization/{paymentMethodId}","baseUrlOptions":["https://api-sandbox.revolv3.com"],"title":"Authorize With Payment Method Id","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"08161cf5-4106-45c7-b538-9517468f7262":{"name":"paymentMethodId","in":"path","description":"The unique identifier for the payment method information","required":true,"schema":{"type":"integer","format":"int64","isRequired":true,"description":"The unique identifier for the payment method information","uniqueKey":"","typeLabel":"integer\u003cint64>"}}},"requestBody":{"content":{"application/json-patch+json":{"schema":{"required":["amount"],"type":"object","properties":{"amount":{"type":"object","description":"The amount information for the payment.","required":["value"],"properties":{"value":{"maximum":9999999.99,"minimum":0,"type":"number","description":"The amount information for the payment. Must NOT be less than zero.","format":"double","isRequired":true,"uniqueKey":"amount.value","typeLabel":"number\u003cdouble>"},"currency":{"type":"string","description":"The three-character ISO currency code.\r\n\r\nDefault value: `USD`","enum":["USD","AED","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CHF","CLP","CNH","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LYD","MAD","MDL","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","SEK","SGD","SHP","SLE","SOS","SRD","STN","SVC","SZL","THB","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","AFN","KPW","LRD","LSL","STD","SYP","TJS","ZMK","ZWD","SLL","MGA","HRK","CDF","BTN","BIF"],"uniqueKey":"amount.currency","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"amount","typeLabel":"object"},"networkProcessing":{"type":"object","description":"Network processing information.\r\n\r\nProcessors supporting this feature: `Adyen`, `Nuvei`, `WorldPay`, `TSYS`, `BridgePay`, `Paymentech`, `PaymentLync`.","properties":{"processingType":{"type":"string","description":"Processing type is used to define the initial or subsequent transaction in a recurring or installment stream.\r\n\r\n**If no value is supplied, a transaction is considered a one-time payment and will not be linked to the initial one.**","enum":["InitialRecurring","Recurring","InitialInstallment","Installment","InitialCOF","MerchantInitiatedCOF","CardholderInitiatedCOF"],"uniqueKey":"networkProcessing.processingType","typeLabel":"enum\u003cstring>"},"originalNetworkTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Element defines the networkTransactionId returned in the response messages for Visa, Mastercard, and Discover Auth/Sale transactions.\r\nYou must include this element and the original value returned for subsequent (after the initial) recurring/installment payments.","uniqueKey":"networkProcessing.originalNetworkTransactionId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"networkProcessing","typeLabel":"object"},"orderProcessingChannel":{"type":"string","description":"Specifies the sales channel through which the shopper provides their card details.\r\n\r\n**Ecommerce** - Internet or electronic commerce transaction.\r\n**Moto** - Single mail or telephone order transaction.\r\n\r\nProcessors supporting this feature: `WorldPay`, `BridgePay`. For other processors, Ecommerce is used by default.","enum":["Ecommerce","Moto"],"uniqueKey":"orderProcessingChannel","typeLabel":"enum\u003cstring>"},"ecommercePlatformUrl":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant's storefront or e-commerce platform URL or domain from which the transaction originates. If provided, this value will be sent to the processor (TSYS only) as the Acceptor URL Address. If not provided, the value configured in Merchant Details (E-Commerce Platform URL) will be used. If neither is available, the request is sent to TSYS without the Acceptor URL Address.","uniqueKey":"ecommercePlatformUrl","typeLabel":"string"},"dynamicDescriptor":{"type":"object","description":"Allows the merchant to define a dynamic descriptor, which appears in the payment statement. \r\nFor dynamic descriptor, special configuration is required.\r\n\r\nProcessors supporting this feature: `Nuvei`, `WorldPay`, `BridgePay`, `EPX`, `Paymentech`, `PaymentLync`.","properties":{"subMerchantId":{"maxLength":15,"type":"string","description":"The internal merchant's ID, which is sent to the relevant card scheme.","uniqueKey":"dynamicDescriptor.subMerchantId","typeLabel":"string"},"subMerchantName":{"maxLength":22,"minLength":0,"type":"string","description":"The merchant name, as is displayed for the transaction on the consumer’s card statement. For payment facilitator only, might consist of the following structure: [Prefix]*[Sub Merchant Name] -\r\nwhere:\r\n1) [Prefix] – The PayFac prefix, approved by processor.\r\n2) '*' – A fixed character.\r\n3) [Sub Merchant Name] – The sub-merchant name.\r\nFor example: aaa*name\r\n\r\nRecommended! An alternative method to define a prefix is by configuring it through the Revolv3 Portal.\r\n\r\n**Nuvei** and **Paymentech** processors: the maximum length of the parameter is 22. Possible prefix length 3 or 5 or 7 or 12 characters.\r\n\r\n**WorldPay** and **PaymentLync** processor: if the value is specified, it must be between 4 and 25 characters. Possible prefix length 3 or 7 or 12 characters. Field accepts numbers, letters and special characters as follows: ampersand, asterisk (zero or one), comma, dash, period, space, or pound sign.\r\n\r\n**BridgePay** processor: the maximum length of the parameter is 46.\r\n\r\n**EPX** processor: the maximum length of the parameter is 20. Possible prefix length 3 or 7 or 9 or 12 characters.","uniqueKey":"dynamicDescriptor.subMerchantName","typeLabel":"string"},"subMerchantPhone":{"maxLength":13,"minLength":0,"type":"string","description":"The merchant (sub-merchant for payment facilitators) contact information, as is displayed for the transaction on the consumer’s card statement.\r\n\r\n**Nuvei** processor: the maximum length of the parameter is 13. It can also be an email address.\r\n**WorldPay** processor: the maximum length of the parameter is 13. Field accepts only numbers.\r\n**BridgePay**, **EPX**, **Paymentech** and **PaymentLync** processor: the maximum length of the parameter is 13.","uniqueKey":"dynamicDescriptor.subMerchantPhone","typeLabel":"string"},"countryCode":{"maxLength":2,"minLength":2,"type":"string","description":"The payment facilitator's sub-merchant's 2-letter ISO country code.","uniqueKey":"dynamicDescriptor.countryCode","typeLabel":"string"},"city":{"oneOf":[{"maxLength":20,"type":"string","description":"City.","uniqueKey":"dynamicDescriptor.city.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","description":"City.","uniqueKey":"dynamicDescriptor.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"dynamicDescriptor.city","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"dynamicDescriptor","typeLabel":"object"},"includeRawProcessorResponse":{"type":"boolean","description":"Determine whether to return raw processor data in the response.","default":false,"uniqueKey":"includeRawProcessorResponse","typeLabel":"boolean"},"reportGroup":{"type":"string","description":"Report Groups could be used to separate your transactions into different categories, so you can view the financial reports by your specific report group names (Worldpay only).","uniqueKey":"reportGroup","typeLabel":"string"},"merchantInvoiceRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the invoice.","uniqueKey":"merchantInvoiceRefId","typeLabel":"string"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":0,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"onlinePaymentCryptogram","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Minimum valid request":{"title":"Minimum valid request","value":{"onlinePaymentCryptogram":null,"networkProcessing":null,"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":false,"reportGroup":null,"merchantInvoiceRefId":"1234-5678-9101"}},"With network processing (Recurring)":{"title":"With network processing (Recurring)","value":{"onlinePaymentCryptogram":null,"networkProcessing":{"processingType":"Recurring","originalNetworkTransactionId":"4731548603657339"},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":false,"reportGroup":null,"merchantInvoiceRefId":null}},"With a dynamic descriptor":{"title":"With a dynamic descriptor","value":{"onlinePaymentCryptogram":null,"networkProcessing":null,"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":{"subMerchantId":null,"subMerchantName":"Test","subMerchantPhone":"408-555-1212","countryCode":null,"city":null},"includeRawProcessorResponse":false,"reportGroup":null,"merchantInvoiceRefId":null}},"With Apple Pay One-Time Payment":{"title":"With Apple Pay One-Time Payment","value":{"onlinePaymentCryptogram":"YwAAAfQAL9ivMOMCCuTzgLlgAgA=","networkProcessing":null,"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":null}},"With Apple Pay Initial Recurring":{"title":"With Apple Pay Initial Recurring","value":{"onlinePaymentCryptogram":"YwAAAfQAL9ivMOMCCuTzgLlgAgA=","networkProcessing":{"processingType":"InitialRecurring","originalNetworkTransactionId":null},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":null}},"With Apple Pay Recurring":{"title":"With Apple Pay Recurring","value":{"onlinePaymentCryptogram":null,"networkProcessing":{"processingType":"Recurring","originalNetworkTransactionId":"4731548603657339"},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":null}},"Full request":{"title":"Full request","value":{"onlinePaymentCryptogram":null,"networkProcessing":{"processingType":"Recurring","originalNetworkTransactionId":"4731548603657339"},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":"example.com","dynamicDescriptor":{"subMerchantId":null,"subMerchantName":"Test","subMerchantPhone":"408-555-1212","countryCode":null,"city":null},"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":"1234-5678-9101"}}},"exampleType":"examples"},"application/json":{"schema":{"required":["amount"],"type":"object","properties":{"amount":{"type":"object","description":"The amount information for the payment.","required":["value"],"properties":{"value":{"maximum":9999999.99,"minimum":0,"type":"number","description":"The amount information for the payment. Must NOT be less than zero.","format":"double","isRequired":true,"uniqueKey":"amount.value","typeLabel":"number\u003cdouble>"},"currency":{"type":"string","description":"The three-character ISO currency code.\r\n\r\nDefault value: `USD`","enum":["USD","AED","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CHF","CLP","CNH","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LYD","MAD","MDL","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","SEK","SGD","SHP","SLE","SOS","SRD","STN","SVC","SZL","THB","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","AFN","KPW","LRD","LSL","STD","SYP","TJS","ZMK","ZWD","SLL","MGA","HRK","CDF","BTN","BIF"],"uniqueKey":"amount.currency","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"amount","typeLabel":"object"},"networkProcessing":{"type":"object","description":"Network processing information.\r\n\r\nProcessors supporting this feature: `Adyen`, `Nuvei`, `WorldPay`, `TSYS`, `BridgePay`, `Paymentech`, `PaymentLync`.","properties":{"processingType":{"type":"string","description":"Processing type is used to define the initial or subsequent transaction in a recurring or installment stream.\r\n\r\n**If no value is supplied, a transaction is considered a one-time payment and will not be linked to the initial one.**","enum":["InitialRecurring","Recurring","InitialInstallment","Installment","InitialCOF","MerchantInitiatedCOF","CardholderInitiatedCOF"],"uniqueKey":"networkProcessing.processingType","typeLabel":"enum\u003cstring>"},"originalNetworkTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Element defines the networkTransactionId returned in the response messages for Visa, Mastercard, and Discover Auth/Sale transactions.\r\nYou must include this element and the original value returned for subsequent (after the initial) recurring/installment payments.","uniqueKey":"networkProcessing.originalNetworkTransactionId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"networkProcessing","typeLabel":"object"},"orderProcessingChannel":{"type":"string","description":"Specifies the sales channel through which the shopper provides their card details.\r\n\r\n**Ecommerce** - Internet or electronic commerce transaction.\r\n**Moto** - Single mail or telephone order transaction.\r\n\r\nProcessors supporting this feature: `WorldPay`, `BridgePay`. For other processors, Ecommerce is used by default.","enum":["Ecommerce","Moto"],"uniqueKey":"orderProcessingChannel","typeLabel":"enum\u003cstring>"},"ecommercePlatformUrl":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant's storefront or e-commerce platform URL or domain from which the transaction originates. If provided, this value will be sent to the processor (TSYS only) as the Acceptor URL Address. If not provided, the value configured in Merchant Details (E-Commerce Platform URL) will be used. If neither is available, the request is sent to TSYS without the Acceptor URL Address.","uniqueKey":"ecommercePlatformUrl","typeLabel":"string"},"dynamicDescriptor":{"type":"object","description":"Allows the merchant to define a dynamic descriptor, which appears in the payment statement. \r\nFor dynamic descriptor, special configuration is required.\r\n\r\nProcessors supporting this feature: `Nuvei`, `WorldPay`, `BridgePay`, `EPX`, `Paymentech`, `PaymentLync`.","properties":{"subMerchantId":{"maxLength":15,"type":"string","description":"The internal merchant's ID, which is sent to the relevant card scheme.","uniqueKey":"dynamicDescriptor.subMerchantId","typeLabel":"string"},"subMerchantName":{"maxLength":22,"minLength":0,"type":"string","description":"The merchant name, as is displayed for the transaction on the consumer’s card statement. For payment facilitator only, might consist of the following structure: [Prefix]*[Sub Merchant Name] -\r\nwhere:\r\n1) [Prefix] – The PayFac prefix, approved by processor.\r\n2) '*' – A fixed character.\r\n3) [Sub Merchant Name] – The sub-merchant name.\r\nFor example: aaa*name\r\n\r\nRecommended! An alternative method to define a prefix is by configuring it through the Revolv3 Portal.\r\n\r\n**Nuvei** and **Paymentech** processors: the maximum length of the parameter is 22. Possible prefix length 3 or 5 or 7 or 12 characters.\r\n\r\n**WorldPay** and **PaymentLync** processor: if the value is specified, it must be between 4 and 25 characters. Possible prefix length 3 or 7 or 12 characters. Field accepts numbers, letters and special characters as follows: ampersand, asterisk (zero or one), comma, dash, period, space, or pound sign.\r\n\r\n**BridgePay** processor: the maximum length of the parameter is 46.\r\n\r\n**EPX** processor: the maximum length of the parameter is 20. Possible prefix length 3 or 7 or 9 or 12 characters.","uniqueKey":"dynamicDescriptor.subMerchantName","typeLabel":"string"},"subMerchantPhone":{"maxLength":13,"minLength":0,"type":"string","description":"The merchant (sub-merchant for payment facilitators) contact information, as is displayed for the transaction on the consumer’s card statement.\r\n\r\n**Nuvei** processor: the maximum length of the parameter is 13. It can also be an email address.\r\n**WorldPay** processor: the maximum length of the parameter is 13. Field accepts only numbers.\r\n**BridgePay**, **EPX**, **Paymentech** and **PaymentLync** processor: the maximum length of the parameter is 13.","uniqueKey":"dynamicDescriptor.subMerchantPhone","typeLabel":"string"},"countryCode":{"maxLength":2,"minLength":2,"type":"string","description":"The payment facilitator's sub-merchant's 2-letter ISO country code.","uniqueKey":"dynamicDescriptor.countryCode","typeLabel":"string"},"city":{"oneOf":[{"maxLength":20,"type":"string","description":"City.","uniqueKey":"dynamicDescriptor.city.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","description":"City.","uniqueKey":"dynamicDescriptor.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"dynamicDescriptor.city","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"dynamicDescriptor","typeLabel":"object"},"includeRawProcessorResponse":{"type":"boolean","description":"Determine whether to return raw processor data in the response.","default":false,"uniqueKey":"includeRawProcessorResponse","typeLabel":"boolean"},"reportGroup":{"type":"string","description":"Report Groups could be used to separate your transactions into different categories, so you can view the financial reports by your specific report group names (Worldpay only).","uniqueKey":"reportGroup","typeLabel":"string"},"merchantInvoiceRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the invoice.","uniqueKey":"merchantInvoiceRefId","typeLabel":"string"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":0,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"onlinePaymentCryptogram","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Minimum valid request":{"title":"Minimum valid request","value":{"onlinePaymentCryptogram":null,"networkProcessing":null,"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":false,"reportGroup":null,"merchantInvoiceRefId":"1234-5678-9101"}},"With network processing (Recurring)":{"title":"With network processing (Recurring)","value":{"onlinePaymentCryptogram":null,"networkProcessing":{"processingType":"Recurring","originalNetworkTransactionId":"4731548603657339"},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":false,"reportGroup":null,"merchantInvoiceRefId":null}},"With a dynamic descriptor":{"title":"With a dynamic descriptor","value":{"onlinePaymentCryptogram":null,"networkProcessing":null,"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":{"subMerchantId":null,"subMerchantName":"Test","subMerchantPhone":"408-555-1212","countryCode":null,"city":null},"includeRawProcessorResponse":false,"reportGroup":null,"merchantInvoiceRefId":null}},"With Apple Pay One-Time Payment":{"title":"With Apple Pay One-Time Payment","value":{"onlinePaymentCryptogram":"YwAAAfQAL9ivMOMCCuTzgLlgAgA=","networkProcessing":null,"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":null}},"With Apple Pay Initial Recurring":{"title":"With Apple Pay Initial Recurring","value":{"onlinePaymentCryptogram":"YwAAAfQAL9ivMOMCCuTzgLlgAgA=","networkProcessing":{"processingType":"InitialRecurring","originalNetworkTransactionId":null},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":null}},"With Apple Pay Recurring":{"title":"With Apple Pay Recurring","value":{"onlinePaymentCryptogram":null,"networkProcessing":{"processingType":"Recurring","originalNetworkTransactionId":"4731548603657339"},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":null}},"Full request":{"title":"Full request","value":{"onlinePaymentCryptogram":null,"networkProcessing":{"processingType":"Recurring","originalNetworkTransactionId":"4731548603657339"},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":"example.com","dynamicDescriptor":{"subMerchantId":null,"subMerchantName":"Test","subMerchantPhone":"408-555-1212","countryCode":null,"city":null},"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":"1234-5678-9101"}}},"exampleType":"examples"},"text/json":{"schema":{"required":["amount"],"type":"object","properties":{"amount":{"type":"object","description":"The amount information for the payment.","required":["value"],"properties":{"value":{"maximum":9999999.99,"minimum":0,"type":"number","description":"The amount information for the payment. Must NOT be less than zero.","format":"double","isRequired":true,"uniqueKey":"amount.value","typeLabel":"number\u003cdouble>"},"currency":{"type":"string","description":"The three-character ISO currency code.\r\n\r\nDefault value: `USD`","enum":["USD","AED","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CHF","CLP","CNH","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LYD","MAD","MDL","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","SEK","SGD","SHP","SLE","SOS","SRD","STN","SVC","SZL","THB","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","AFN","KPW","LRD","LSL","STD","SYP","TJS","ZMK","ZWD","SLL","MGA","HRK","CDF","BTN","BIF"],"uniqueKey":"amount.currency","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"amount","typeLabel":"object"},"networkProcessing":{"type":"object","description":"Network processing information.\r\n\r\nProcessors supporting this feature: `Adyen`, `Nuvei`, `WorldPay`, `TSYS`, `BridgePay`, `Paymentech`, `PaymentLync`.","properties":{"processingType":{"type":"string","description":"Processing type is used to define the initial or subsequent transaction in a recurring or installment stream.\r\n\r\n**If no value is supplied, a transaction is considered a one-time payment and will not be linked to the initial one.**","enum":["InitialRecurring","Recurring","InitialInstallment","Installment","InitialCOF","MerchantInitiatedCOF","CardholderInitiatedCOF"],"uniqueKey":"networkProcessing.processingType","typeLabel":"enum\u003cstring>"},"originalNetworkTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Element defines the networkTransactionId returned in the response messages for Visa, Mastercard, and Discover Auth/Sale transactions.\r\nYou must include this element and the original value returned for subsequent (after the initial) recurring/installment payments.","uniqueKey":"networkProcessing.originalNetworkTransactionId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"networkProcessing","typeLabel":"object"},"orderProcessingChannel":{"type":"string","description":"Specifies the sales channel through which the shopper provides their card details.\r\n\r\n**Ecommerce** - Internet or electronic commerce transaction.\r\n**Moto** - Single mail or telephone order transaction.\r\n\r\nProcessors supporting this feature: `WorldPay`, `BridgePay`. For other processors, Ecommerce is used by default.","enum":["Ecommerce","Moto"],"uniqueKey":"orderProcessingChannel","typeLabel":"enum\u003cstring>"},"ecommercePlatformUrl":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant's storefront or e-commerce platform URL or domain from which the transaction originates. If provided, this value will be sent to the processor (TSYS only) as the Acceptor URL Address. If not provided, the value configured in Merchant Details (E-Commerce Platform URL) will be used. If neither is available, the request is sent to TSYS without the Acceptor URL Address.","uniqueKey":"ecommercePlatformUrl","typeLabel":"string"},"dynamicDescriptor":{"type":"object","description":"Allows the merchant to define a dynamic descriptor, which appears in the payment statement. \r\nFor dynamic descriptor, special configuration is required.\r\n\r\nProcessors supporting this feature: `Nuvei`, `WorldPay`, `BridgePay`, `EPX`, `Paymentech`, `PaymentLync`.","properties":{"subMerchantId":{"maxLength":15,"type":"string","description":"The internal merchant's ID, which is sent to the relevant card scheme.","uniqueKey":"dynamicDescriptor.subMerchantId","typeLabel":"string"},"subMerchantName":{"maxLength":22,"minLength":0,"type":"string","description":"The merchant name, as is displayed for the transaction on the consumer’s card statement. For payment facilitator only, might consist of the following structure: [Prefix]*[Sub Merchant Name] -\r\nwhere:\r\n1) [Prefix] – The PayFac prefix, approved by processor.\r\n2) '*' – A fixed character.\r\n3) [Sub Merchant Name] – The sub-merchant name.\r\nFor example: aaa*name\r\n\r\nRecommended! An alternative method to define a prefix is by configuring it through the Revolv3 Portal.\r\n\r\n**Nuvei** and **Paymentech** processors: the maximum length of the parameter is 22. Possible prefix length 3 or 5 or 7 or 12 characters.\r\n\r\n**WorldPay** and **PaymentLync** processor: if the value is specified, it must be between 4 and 25 characters. Possible prefix length 3 or 7 or 12 characters. Field accepts numbers, letters and special characters as follows: ampersand, asterisk (zero or one), comma, dash, period, space, or pound sign.\r\n\r\n**BridgePay** processor: the maximum length of the parameter is 46.\r\n\r\n**EPX** processor: the maximum length of the parameter is 20. Possible prefix length 3 or 7 or 9 or 12 characters.","uniqueKey":"dynamicDescriptor.subMerchantName","typeLabel":"string"},"subMerchantPhone":{"maxLength":13,"minLength":0,"type":"string","description":"The merchant (sub-merchant for payment facilitators) contact information, as is displayed for the transaction on the consumer’s card statement.\r\n\r\n**Nuvei** processor: the maximum length of the parameter is 13. It can also be an email address.\r\n**WorldPay** processor: the maximum length of the parameter is 13. Field accepts only numbers.\r\n**BridgePay**, **EPX**, **Paymentech** and **PaymentLync** processor: the maximum length of the parameter is 13.","uniqueKey":"dynamicDescriptor.subMerchantPhone","typeLabel":"string"},"countryCode":{"maxLength":2,"minLength":2,"type":"string","description":"The payment facilitator's sub-merchant's 2-letter ISO country code.","uniqueKey":"dynamicDescriptor.countryCode","typeLabel":"string"},"city":{"oneOf":[{"maxLength":20,"type":"string","description":"City.","uniqueKey":"dynamicDescriptor.city.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","description":"City.","uniqueKey":"dynamicDescriptor.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"dynamicDescriptor.city","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"dynamicDescriptor","typeLabel":"object"},"includeRawProcessorResponse":{"type":"boolean","description":"Determine whether to return raw processor data in the response.","default":false,"uniqueKey":"includeRawProcessorResponse","typeLabel":"boolean"},"reportGroup":{"type":"string","description":"Report Groups could be used to separate your transactions into different categories, so you can view the financial reports by your specific report group names (Worldpay only).","uniqueKey":"reportGroup","typeLabel":"string"},"merchantInvoiceRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the invoice.","uniqueKey":"merchantInvoiceRefId","typeLabel":"string"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":0,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"onlinePaymentCryptogram","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Minimum valid request":{"title":"Minimum valid request","value":{"onlinePaymentCryptogram":null,"networkProcessing":null,"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":false,"reportGroup":null,"merchantInvoiceRefId":"1234-5678-9101"}},"With network processing (Recurring)":{"title":"With network processing (Recurring)","value":{"onlinePaymentCryptogram":null,"networkProcessing":{"processingType":"Recurring","originalNetworkTransactionId":"4731548603657339"},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":false,"reportGroup":null,"merchantInvoiceRefId":null}},"With a dynamic descriptor":{"title":"With a dynamic descriptor","value":{"onlinePaymentCryptogram":null,"networkProcessing":null,"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":{"subMerchantId":null,"subMerchantName":"Test","subMerchantPhone":"408-555-1212","countryCode":null,"city":null},"includeRawProcessorResponse":false,"reportGroup":null,"merchantInvoiceRefId":null}},"With Apple Pay One-Time Payment":{"title":"With Apple Pay One-Time Payment","value":{"onlinePaymentCryptogram":"YwAAAfQAL9ivMOMCCuTzgLlgAgA=","networkProcessing":null,"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":null}},"With Apple Pay Initial Recurring":{"title":"With Apple Pay Initial Recurring","value":{"onlinePaymentCryptogram":"YwAAAfQAL9ivMOMCCuTzgLlgAgA=","networkProcessing":{"processingType":"InitialRecurring","originalNetworkTransactionId":null},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":null}},"With Apple Pay Recurring":{"title":"With Apple Pay Recurring","value":{"onlinePaymentCryptogram":null,"networkProcessing":{"processingType":"Recurring","originalNetworkTransactionId":"4731548603657339"},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":null}},"Full request":{"title":"Full request","value":{"onlinePaymentCryptogram":null,"networkProcessing":{"processingType":"Recurring","originalNetworkTransactionId":"4731548603657339"},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":"example.com","dynamicDescriptor":{"subMerchantId":null,"subMerchantName":"Test","subMerchantPhone":"408-555-1212","countryCode":null,"city":null},"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":"1234-5678-9101"}}},"exampleType":"examples"},"application/*+json":{"schema":{"required":["amount"],"type":"object","properties":{"amount":{"type":"object","description":"The amount information for the payment.","required":["value"],"properties":{"value":{"maximum":9999999.99,"minimum":0,"type":"number","description":"The amount information for the payment. Must NOT be less than zero.","format":"double","isRequired":true,"uniqueKey":"amount.value","typeLabel":"number\u003cdouble>"},"currency":{"type":"string","description":"The three-character ISO currency code.\r\n\r\nDefault value: `USD`","enum":["USD","AED","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BMD","BND","BOB","BRL","BSD","BWP","BYN","BZD","CAD","CHF","CLP","CNH","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LYD","MAD","MDL","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","SEK","SGD","SHP","SLE","SOS","SRD","STN","SVC","SZL","THB","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","AFN","KPW","LRD","LSL","STD","SYP","TJS","ZMK","ZWD","SLL","MGA","HRK","CDF","BTN","BIF"],"uniqueKey":"amount.currency","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"amount","typeLabel":"object"},"networkProcessing":{"type":"object","description":"Network processing information.\r\n\r\nProcessors supporting this feature: `Adyen`, `Nuvei`, `WorldPay`, `TSYS`, `BridgePay`, `Paymentech`, `PaymentLync`.","properties":{"processingType":{"type":"string","description":"Processing type is used to define the initial or subsequent transaction in a recurring or installment stream.\r\n\r\n**If no value is supplied, a transaction is considered a one-time payment and will not be linked to the initial one.**","enum":["InitialRecurring","Recurring","InitialInstallment","Installment","InitialCOF","MerchantInitiatedCOF","CardholderInitiatedCOF"],"uniqueKey":"networkProcessing.processingType","typeLabel":"enum\u003cstring>"},"originalNetworkTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Element defines the networkTransactionId returned in the response messages for Visa, Mastercard, and Discover Auth/Sale transactions.\r\nYou must include this element and the original value returned for subsequent (after the initial) recurring/installment payments.","uniqueKey":"networkProcessing.originalNetworkTransactionId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"networkProcessing","typeLabel":"object"},"orderProcessingChannel":{"type":"string","description":"Specifies the sales channel through which the shopper provides their card details.\r\n\r\n**Ecommerce** - Internet or electronic commerce transaction.\r\n**Moto** - Single mail or telephone order transaction.\r\n\r\nProcessors supporting this feature: `WorldPay`, `BridgePay`. For other processors, Ecommerce is used by default.","enum":["Ecommerce","Moto"],"uniqueKey":"orderProcessingChannel","typeLabel":"enum\u003cstring>"},"ecommercePlatformUrl":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant's storefront or e-commerce platform URL or domain from which the transaction originates. If provided, this value will be sent to the processor (TSYS only) as the Acceptor URL Address. If not provided, the value configured in Merchant Details (E-Commerce Platform URL) will be used. If neither is available, the request is sent to TSYS without the Acceptor URL Address.","uniqueKey":"ecommercePlatformUrl","typeLabel":"string"},"dynamicDescriptor":{"type":"object","description":"Allows the merchant to define a dynamic descriptor, which appears in the payment statement. \r\nFor dynamic descriptor, special configuration is required.\r\n\r\nProcessors supporting this feature: `Nuvei`, `WorldPay`, `BridgePay`, `EPX`, `Paymentech`, `PaymentLync`.","properties":{"subMerchantId":{"maxLength":15,"type":"string","description":"The internal merchant's ID, which is sent to the relevant card scheme.","uniqueKey":"dynamicDescriptor.subMerchantId","typeLabel":"string"},"subMerchantName":{"maxLength":22,"minLength":0,"type":"string","description":"The merchant name, as is displayed for the transaction on the consumer’s card statement. For payment facilitator only, might consist of the following structure: [Prefix]*[Sub Merchant Name] -\r\nwhere:\r\n1) [Prefix] – The PayFac prefix, approved by processor.\r\n2) '*' – A fixed character.\r\n3) [Sub Merchant Name] – The sub-merchant name.\r\nFor example: aaa*name\r\n\r\nRecommended! An alternative method to define a prefix is by configuring it through the Revolv3 Portal.\r\n\r\n**Nuvei** and **Paymentech** processors: the maximum length of the parameter is 22. Possible prefix length 3 or 5 or 7 or 12 characters.\r\n\r\n**WorldPay** and **PaymentLync** processor: if the value is specified, it must be between 4 and 25 characters. Possible prefix length 3 or 7 or 12 characters. Field accepts numbers, letters and special characters as follows: ampersand, asterisk (zero or one), comma, dash, period, space, or pound sign.\r\n\r\n**BridgePay** processor: the maximum length of the parameter is 46.\r\n\r\n**EPX** processor: the maximum length of the parameter is 20. Possible prefix length 3 or 7 or 9 or 12 characters.","uniqueKey":"dynamicDescriptor.subMerchantName","typeLabel":"string"},"subMerchantPhone":{"maxLength":13,"minLength":0,"type":"string","description":"The merchant (sub-merchant for payment facilitators) contact information, as is displayed for the transaction on the consumer’s card statement.\r\n\r\n**Nuvei** processor: the maximum length of the parameter is 13. It can also be an email address.\r\n**WorldPay** processor: the maximum length of the parameter is 13. Field accepts only numbers.\r\n**BridgePay**, **EPX**, **Paymentech** and **PaymentLync** processor: the maximum length of the parameter is 13.","uniqueKey":"dynamicDescriptor.subMerchantPhone","typeLabel":"string"},"countryCode":{"maxLength":2,"minLength":2,"type":"string","description":"The payment facilitator's sub-merchant's 2-letter ISO country code.","uniqueKey":"dynamicDescriptor.countryCode","typeLabel":"string"},"city":{"oneOf":[{"maxLength":20,"type":"string","description":"City.","uniqueKey":"dynamicDescriptor.city.oneOf.0","typeLabel":"string"},{"maxLength":20,"type":"null","description":"City.","uniqueKey":"dynamicDescriptor.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"dynamicDescriptor.city","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"dynamicDescriptor","typeLabel":"object"},"includeRawProcessorResponse":{"type":"boolean","description":"Determine whether to return raw processor data in the response.","default":false,"uniqueKey":"includeRawProcessorResponse","typeLabel":"boolean"},"reportGroup":{"type":"string","description":"Report Groups could be used to separate your transactions into different categories, so you can view the financial reports by your specific report group names (Worldpay only).","uniqueKey":"reportGroup","typeLabel":"string"},"merchantInvoiceRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the invoice.","uniqueKey":"merchantInvoiceRefId","typeLabel":"string"},"onlinePaymentCryptogram":{"maxLength":512,"minLength":0,"type":"string","description":"Decrypted package online payment cryptogram for a digital wallet.","uniqueKey":"onlinePaymentCryptogram","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Minimum valid request":{"title":"Minimum valid request","value":{"onlinePaymentCryptogram":null,"networkProcessing":null,"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":false,"reportGroup":null,"merchantInvoiceRefId":"1234-5678-9101"}},"With network processing (Recurring)":{"title":"With network processing (Recurring)","value":{"onlinePaymentCryptogram":null,"networkProcessing":{"processingType":"Recurring","originalNetworkTransactionId":"4731548603657339"},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":false,"reportGroup":null,"merchantInvoiceRefId":null}},"With a dynamic descriptor":{"title":"With a dynamic descriptor","value":{"onlinePaymentCryptogram":null,"networkProcessing":null,"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":{"subMerchantId":null,"subMerchantName":"Test","subMerchantPhone":"408-555-1212","countryCode":null,"city":null},"includeRawProcessorResponse":false,"reportGroup":null,"merchantInvoiceRefId":null}},"With Apple Pay One-Time Payment":{"title":"With Apple Pay One-Time Payment","value":{"onlinePaymentCryptogram":"YwAAAfQAL9ivMOMCCuTzgLlgAgA=","networkProcessing":null,"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":null}},"With Apple Pay Initial Recurring":{"title":"With Apple Pay Initial Recurring","value":{"onlinePaymentCryptogram":"YwAAAfQAL9ivMOMCCuTzgLlgAgA=","networkProcessing":{"processingType":"InitialRecurring","originalNetworkTransactionId":null},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":null}},"With Apple Pay Recurring":{"title":"With Apple Pay Recurring","value":{"onlinePaymentCryptogram":null,"networkProcessing":{"processingType":"Recurring","originalNetworkTransactionId":"4731548603657339"},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":null,"dynamicDescriptor":null,"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":null}},"Full request":{"title":"Full request","value":{"onlinePaymentCryptogram":null,"networkProcessing":{"processingType":"Recurring","originalNetworkTransactionId":"4731548603657339"},"amount":{"currency":"USD","value":30.99},"orderProcessingChannel":null,"ecommercePlatformUrl":"example.com","dynamicDescriptor":{"subMerchantId":null,"subMerchantName":"Test","subMerchantPhone":"408-555-1212","countryCode":null,"city":null},"includeRawProcessorResponse":true,"reportGroup":null,"merchantInvoiceRefId":"1234-5678-9101"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"d85b4900-5bf4-43aa-a734-d4e02ce62dcc":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"networkTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"The identifier returned for Visa, Mastercard, and Discover transactions. Visa and Discover use this value to link subsequent payments in a recurring/installment stream back to the initial transaction.\r\nYou must include this value in the request message (**originalNetworkTransactionId** element) for subsequent recurring payments.","uniqueKey":"networkTransactionId","typeLabel":"string"},"paymentMethodAuthorizationId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"Unique identifier for a previously pre-authorized payment method.","format":"int64","uniqueKey":"paymentMethodAuthorizationId","typeLabel":"integer\u003cint64>"},"paymentMethod":{"type":"object","description":"The payment method information for the payment.","properties":{"paymentMethodId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier for the payment method information.","format":"int64","uniqueKey":"paymentMethod.paymentMethodId","typeLabel":"integer\u003cint64>"},"billingAddressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"paymentMethod.billingAddressId","typeLabel":"integer\u003cint64>"},"billingAddress":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"paymentMethod.billingAddress.addressId","typeLabel":"integer\u003cint64>"},"addressLine1":{"oneOf":[{"maxLength":40,"minLength":2,"type":"string","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":40,"minLength":2,"type":"null","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":40,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"paymentMethod.billingAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":25,"minLength":2,"type":"string","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":25,"minLength":2,"type":"null","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Two-letter state abbreviation.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Two-letter state abbreviation.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.postalCode","typeLabel":"string | null"},"phoneNumber":{"maxLength":20,"minLength":0,"type":"string","description":"The phone number associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"paymentMethod.billingAddress.email","typeLabel":"string\u003cemail>"},"country":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Country.","uniqueKey":"paymentMethod.billingAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Country.","uniqueKey":"paymentMethod.billingAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod.billingAddress","typeLabel":"object"},"billingFirstName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentMethod.billingFirstName.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentMethod.billingFirstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingFirstName","typeLabel":"string | null"},"billingLastName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentMethod.billingLastName.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentMethod.billingLastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingLastName","typeLabel":"string | null"},"merchantPaymentMethodRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"paymentMethod.merchantPaymentMethodRefId","typeLabel":"string"},"paymentMethodAchDetails":{"oneOf":[{"type":"object","description":"ACH account information.","properties":{"accountNumberLast4Digits":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Last 4 digits of the bank account.","uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.0.accountNumberLast4Digits","typeLabel":"string"},"accountNumberLength":{"maximum":17,"minimum":4,"type":"integer","description":"Bank account number length.","format":"int32","uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.0.accountNumberLength","typeLabel":"integer\u003cint32>"},"accountType":{"maxLength":8,"minLength":0,"pattern":"^(Checking|Savings)$","type":"string","description":"**Conditional**: the account type is required if the ACH payment method type is supplied in the request.\r\n\r\nBank account type. Allowed values: Checking, Savings. Case-insensitive.","uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.0.accountType","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.0","typeLabel":"object"},{"type":"null","description":"ACH account information.","properties":{"accountNumberLast4Digits":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Last 4 digits of the bank account."},"accountNumberLength":{"maximum":17,"minimum":4,"type":"integer","description":"Bank account number length.","format":"int32"},"accountType":{"maxLength":8,"minLength":0,"pattern":"^(Checking|Savings)$","type":"string","description":"**Conditional**: the account type is required if the ACH payment method type is supplied in the request.\r\n\r\nBank account type. Allowed values: Checking, Savings. Case-insensitive."}},"additionalProperties":false,"uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodAchDetails","typeLabel":"object | null"},"paymentMethodCreditCardDetails":{"oneOf":[{"type":"object","description":"The details of credit card payment method.","properties":{"binNumber":{"maxLength":6,"minLength":0,"pattern":"^\\d{1,6}$","type":"string","description":"First 6 digits (BIN) of the card number.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.binNumber","typeLabel":"string"},"paymentLast4Digit":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Payment card last 4 digits.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentLast4Digit","typeLabel":"string"},"paymentExpirationDate":{"oneOf":[{"maxLength":4,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate.oneOf.0","typeLabel":"string\u003cMMYY>"},{"maxLength":4,"minLength":0,"type":"null","description":"The card expiration date.","format":"MMYY","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate","typeLabel":"string\u003cMMYY> | null"},"accountUpdateMessage":{"maxLength":500,"minLength":0,"type":"string","description":"Account updater message, if available.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateMessage","typeLabel":"string"},"accountUpdateDateTime":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","description":"UTC date-time of the last account updater event.","format":"YYYY-MM-DDThh:mm:ss","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateDateTime.oneOf.0","typeLabel":"string\u003cYYYY-MM-DDThh:mm:ss>"},{"maxLength":20,"minLength":0,"type":"null","description":"UTC date-time of the last account updater event.","format":"YYYY-MM-DDThh:mm:ss","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateDateTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateDateTime","typeLabel":"string\u003cYYYY-MM-DDThh:mm:ss> | null"},"accountUpdateCode":{"maxLength":50,"minLength":0,"type":"string","description":"Processor response code of the last account updater event.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateCode","typeLabel":"string"},"paymentAccountNumber":{"oneOf":[{"type":"string","description":"The full unmasked card number. Only populated for merchants verified as PCI DSS Level 1 and only in case account updater performed.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full unmasked card number. Only populated for merchants verified as PCI DSS Level 1 and only in case account updater performed.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0","typeLabel":"object"},{"type":"null","description":"The details of credit card payment method.","properties":{"binNumber":{"maxLength":6,"minLength":0,"pattern":"^\\d{1,6}$","type":"string","description":"First 6 digits (BIN) of the card number."},"paymentLast4Digit":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Payment card last 4 digits."},"paymentExpirationDate":{"oneOf":[{"maxLength":4,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY"},{"maxLength":4,"minLength":0,"type":"null","description":"The card expiration date.","format":"MMYY"}]},"accountUpdateMessage":{"maxLength":500,"minLength":0,"type":"string","description":"Account updater message, if available."},"accountUpdateDateTime":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","description":"UTC date-time of the last account updater event.","format":"YYYY-MM-DDThh:mm:ss"},{"maxLength":20,"minLength":0,"type":"null","description":"UTC date-time of the last account updater event.","format":"YYYY-MM-DDThh:mm:ss"}]},"accountUpdateCode":{"maxLength":50,"minLength":0,"type":"string","description":"Processor response code of the last account updater event."},"paymentAccountNumber":{"oneOf":[{"type":"string","description":"The full unmasked card number. Only populated for merchants verified as PCI DSS Level 1 and only in case account updater performed."},{"type":"null","description":"The full unmasked card number. Only populated for merchants verified as PCI DSS Level 1 and only in case account updater performed."}]}},"additionalProperties":false,"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod","typeLabel":"object"},"paymentProcessor":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the processor by which the transaction was processed.","uniqueKey":"paymentProcessor","typeLabel":"string"},"processorMerchantId":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant account ID (MID) of the processor by which the transaction was processed.","uniqueKey":"processorMerchantId","typeLabel":"string"},"responseMessage":{"maxLength":500,"minLength":0,"type":"string","description":"The processor response message.","uniqueKey":"responseMessage","typeLabel":"string"},"responseCode":{"maxLength":10,"minLength":0,"type":"string","description":"The processor response code.","uniqueKey":"responseCode","typeLabel":"string"},"rawResponse":{"maxLength":10000,"minLength":0,"type":"string","description":"**Conditional. The value is returned if includeRawProcessorResponse = true.**\r\nThis field contains the raw data received from the processor after attempting to bill this payment. It does not contain any sensitive information. The field value is a string with the serialized response from the processor in JSON format.","uniqueKey":"rawResponse","typeLabel":"string"},"message":{"maxLength":500,"minLength":0,"type":"string","description":"The message returned directly from payment processor or a special message provided by system. ","uniqueKey":"message","typeLabel":"string"},"processorResponseDateTime":{"maxLength":40,"type":"string","description":"UTC timestamp of the payment processor response (format: YYYY-MM-DDThh:mm:ss).","format":"date-time","uniqueKey":"processorResponseDateTime","typeLabel":"string\u003cdate-time>"},"authCode":{"maxLength":20,"minLength":0,"type":"string","description":"Transaction authorization code.","uniqueKey":"authCode","typeLabel":"string"},"processorTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Payment Processor Transaction Id.","uniqueKey":"processorTransactionId","typeLabel":"string"},"revolv3ResponseCode":{"maxLength":10,"minLength":0,"type":"string","description":"Standardized internal response code indicating the outcome of the request.","uniqueKey":"revolv3ResponseCode","typeLabel":"string"},"revolv3ResponseMessage":{"maxLength":500,"minLength":0,"type":"string","description":"Message providing additional details about the response code.","uniqueKey":"revolv3ResponseMessage","typeLabel":"string"},"merchantInvoiceRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the invoice.","uniqueKey":"merchantInvoiceRefId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Approved authorization":{"title":"Approved authorization","value":{"networkTransactionId":"13d5c9b9-3a2a-4c27-9751-45b908f34496","paymentMethodAuthorizationId":1,"paymentMethod":{"paymentMethodId":1,"billingAddressId":1,"billingAddress":{"addressId":1,"addressLine1":"1 Default Street","addressLine2":null,"city":"Los Angeles","state":"CA","postalCode":"90210","phoneNumber":null,"email":null,"country":"US"},"billingFirstName":"John","billingLastName":"Doe","merchantPaymentMethodRefId":"custom-payment-method-ref-id-001","paymentMethodAchDetails":null,"paymentMethodCreditCardDetails":{"binNumber":"411111","paymentLast4Digit":"1111","paymentExpirationDate":"0835","accountUpdateMessage":null,"accountUpdateDateTime":null,"accountUpdateCode":null,"paymentAccountNumber":null}},"paymentProcessor":"WorldPay","processorMerchantId":"10071676","responseMessage":"Approved","responseCode":"000","rawResponse":null,"message":"Approved","processorResponseDateTime":null,"authCode":null,"processorTransactionId":null,"revolv3ResponseCode":null,"revolv3ResponseMessage":null,"merchantInvoiceRefId":"1234-5678-9101"}},"Failed authorization":{"title":"Failed authorization","value":{"networkTransactionId":"5e0a6f27-a748-4c11-b203-9fbfc9b08611","paymentMethodAuthorizationId":null,"paymentMethod":{"paymentMethodId":1,"billingAddressId":1,"billingAddress":{"addressId":1,"addressLine1":"1 Default Street","addressLine2":null,"city":"Los Angeles","state":"CA","postalCode":"90210","phoneNumber":null,"email":null,"country":"US"},"billingFirstName":"John","billingLastName":"Doe","merchantPaymentMethodRefId":"custom-payment-method-ref-id-001","paymentMethodAchDetails":null,"paymentMethodCreditCardDetails":{"binNumber":"411111","paymentLast4Digit":"1111","paymentExpirationDate":"0835","accountUpdateMessage":null,"accountUpdateDateTime":null,"accountUpdateCode":null,"paymentAccountNumber":null}},"paymentProcessor":"WorldPay","processorMerchantId":"10071676","responseMessage":"Pick Up Card","responseCode":"303","rawResponse":null,"message":"Pick Up Card. Unable to authorize payment for payment method 1; Transaction Id: 3.","processorResponseDateTime":null,"authCode":null,"processorTransactionId":null,"revolv3ResponseCode":null,"revolv3ResponseMessage":null,"merchantInvoiceRefId":"1234-5678-9101"}}},"exampleType":"examples"},"application/json":{"schema":{"type":"object","properties":{"networkTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"The identifier returned for Visa, Mastercard, and Discover transactions. Visa and Discover use this value to link subsequent payments in a recurring/installment stream back to the initial transaction.\r\nYou must include this value in the request message (**originalNetworkTransactionId** element) for subsequent recurring payments.","uniqueKey":"networkTransactionId","typeLabel":"string"},"paymentMethodAuthorizationId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"Unique identifier for a previously pre-authorized payment method.","format":"int64","uniqueKey":"paymentMethodAuthorizationId","typeLabel":"integer\u003cint64>"},"paymentMethod":{"type":"object","description":"The payment method information for the payment.","properties":{"paymentMethodId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier for the payment method information.","format":"int64","uniqueKey":"paymentMethod.paymentMethodId","typeLabel":"integer\u003cint64>"},"billingAddressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"paymentMethod.billingAddressId","typeLabel":"integer\u003cint64>"},"billingAddress":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"paymentMethod.billingAddress.addressId","typeLabel":"integer\u003cint64>"},"addressLine1":{"oneOf":[{"maxLength":40,"minLength":2,"type":"string","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":40,"minLength":2,"type":"null","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":40,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"paymentMethod.billingAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":25,"minLength":2,"type":"string","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":25,"minLength":2,"type":"null","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Two-letter state abbreviation.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Two-letter state abbreviation.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.postalCode","typeLabel":"string | null"},"phoneNumber":{"maxLength":20,"minLength":0,"type":"string","description":"The phone number associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"paymentMethod.billingAddress.email","typeLabel":"string\u003cemail>"},"country":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Country.","uniqueKey":"paymentMethod.billingAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Country.","uniqueKey":"paymentMethod.billingAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod.billingAddress","typeLabel":"object"},"billingFirstName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentMethod.billingFirstName.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentMethod.billingFirstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingFirstName","typeLabel":"string | null"},"billingLastName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentMethod.billingLastName.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentMethod.billingLastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingLastName","typeLabel":"string | null"},"merchantPaymentMethodRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"paymentMethod.merchantPaymentMethodRefId","typeLabel":"string"},"paymentMethodAchDetails":{"oneOf":[{"type":"object","description":"ACH account information.","properties":{"accountNumberLast4Digits":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Last 4 digits of the bank account.","uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.0.accountNumberLast4Digits","typeLabel":"string"},"accountNumberLength":{"maximum":17,"minimum":4,"type":"integer","description":"Bank account number length.","format":"int32","uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.0.accountNumberLength","typeLabel":"integer\u003cint32>"},"accountType":{"maxLength":8,"minLength":0,"pattern":"^(Checking|Savings)$","type":"string","description":"**Conditional**: the account type is required if the ACH payment method type is supplied in the request.\r\n\r\nBank account type. Allowed values: Checking, Savings. Case-insensitive.","uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.0.accountType","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.0","typeLabel":"object"},{"type":"null","description":"ACH account information.","properties":{"accountNumberLast4Digits":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Last 4 digits of the bank account."},"accountNumberLength":{"maximum":17,"minimum":4,"type":"integer","description":"Bank account number length.","format":"int32"},"accountType":{"maxLength":8,"minLength":0,"pattern":"^(Checking|Savings)$","type":"string","description":"**Conditional**: the account type is required if the ACH payment method type is supplied in the request.\r\n\r\nBank account type. Allowed values: Checking, Savings. Case-insensitive."}},"additionalProperties":false,"uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodAchDetails","typeLabel":"object | null"},"paymentMethodCreditCardDetails":{"oneOf":[{"type":"object","description":"The details of credit card payment method.","properties":{"binNumber":{"maxLength":6,"minLength":0,"pattern":"^\\d{1,6}$","type":"string","description":"First 6 digits (BIN) of the card number.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.binNumber","typeLabel":"string"},"paymentLast4Digit":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Payment card last 4 digits.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentLast4Digit","typeLabel":"string"},"paymentExpirationDate":{"oneOf":[{"maxLength":4,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate.oneOf.0","typeLabel":"string\u003cMMYY>"},{"maxLength":4,"minLength":0,"type":"null","description":"The card expiration date.","format":"MMYY","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate","typeLabel":"string\u003cMMYY> | null"},"accountUpdateMessage":{"maxLength":500,"minLength":0,"type":"string","description":"Account updater message, if available.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateMessage","typeLabel":"string"},"accountUpdateDateTime":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","description":"UTC date-time of the last account updater event.","format":"YYYY-MM-DDThh:mm:ss","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateDateTime.oneOf.0","typeLabel":"string\u003cYYYY-MM-DDThh:mm:ss>"},{"maxLength":20,"minLength":0,"type":"null","description":"UTC date-time of the last account updater event.","format":"YYYY-MM-DDThh:mm:ss","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateDateTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateDateTime","typeLabel":"string\u003cYYYY-MM-DDThh:mm:ss> | null"},"accountUpdateCode":{"maxLength":50,"minLength":0,"type":"string","description":"Processor response code of the last account updater event.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateCode","typeLabel":"string"},"paymentAccountNumber":{"oneOf":[{"type":"string","description":"The full unmasked card number. Only populated for merchants verified as PCI DSS Level 1 and only in case account updater performed.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full unmasked card number. Only populated for merchants verified as PCI DSS Level 1 and only in case account updater performed.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0","typeLabel":"object"},{"type":"null","description":"The details of credit card payment method.","properties":{"binNumber":{"maxLength":6,"minLength":0,"pattern":"^\\d{1,6}$","type":"string","description":"First 6 digits (BIN) of the card number."},"paymentLast4Digit":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Payment card last 4 digits."},"paymentExpirationDate":{"oneOf":[{"maxLength":4,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY"},{"maxLength":4,"minLength":0,"type":"null","description":"The card expiration date.","format":"MMYY"}]},"accountUpdateMessage":{"maxLength":500,"minLength":0,"type":"string","description":"Account updater message, if available."},"accountUpdateDateTime":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","description":"UTC date-time of the last account updater event.","format":"YYYY-MM-DDThh:mm:ss"},{"maxLength":20,"minLength":0,"type":"null","description":"UTC date-time of the last account updater event.","format":"YYYY-MM-DDThh:mm:ss"}]},"accountUpdateCode":{"maxLength":50,"minLength":0,"type":"string","description":"Processor response code of the last account updater event."},"paymentAccountNumber":{"oneOf":[{"type":"string","description":"The full unmasked card number. Only populated for merchants verified as PCI DSS Level 1 and only in case account updater performed."},{"type":"null","description":"The full unmasked card number. Only populated for merchants verified as PCI DSS Level 1 and only in case account updater performed."}]}},"additionalProperties":false,"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod","typeLabel":"object"},"paymentProcessor":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the processor by which the transaction was processed.","uniqueKey":"paymentProcessor","typeLabel":"string"},"processorMerchantId":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant account ID (MID) of the processor by which the transaction was processed.","uniqueKey":"processorMerchantId","typeLabel":"string"},"responseMessage":{"maxLength":500,"minLength":0,"type":"string","description":"The processor response message.","uniqueKey":"responseMessage","typeLabel":"string"},"responseCode":{"maxLength":10,"minLength":0,"type":"string","description":"The processor response code.","uniqueKey":"responseCode","typeLabel":"string"},"rawResponse":{"maxLength":10000,"minLength":0,"type":"string","description":"**Conditional. The value is returned if includeRawProcessorResponse = true.**\r\nThis field contains the raw data received from the processor after attempting to bill this payment. It does not contain any sensitive information. The field value is a string with the serialized response from the processor in JSON format.","uniqueKey":"rawResponse","typeLabel":"string"},"message":{"maxLength":500,"minLength":0,"type":"string","description":"The message returned directly from payment processor or a special message provided by system. ","uniqueKey":"message","typeLabel":"string"},"processorResponseDateTime":{"maxLength":40,"type":"string","description":"UTC timestamp of the payment processor response (format: YYYY-MM-DDThh:mm:ss).","format":"date-time","uniqueKey":"processorResponseDateTime","typeLabel":"string\u003cdate-time>"},"authCode":{"maxLength":20,"minLength":0,"type":"string","description":"Transaction authorization code.","uniqueKey":"authCode","typeLabel":"string"},"processorTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Payment Processor Transaction Id.","uniqueKey":"processorTransactionId","typeLabel":"string"},"revolv3ResponseCode":{"maxLength":10,"minLength":0,"type":"string","description":"Standardized internal response code indicating the outcome of the request.","uniqueKey":"revolv3ResponseCode","typeLabel":"string"},"revolv3ResponseMessage":{"maxLength":500,"minLength":0,"type":"string","description":"Message providing additional details about the response code.","uniqueKey":"revolv3ResponseMessage","typeLabel":"string"},"merchantInvoiceRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the invoice.","uniqueKey":"merchantInvoiceRefId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Approved authorization":{"title":"Approved authorization","value":{"networkTransactionId":"13d5c9b9-3a2a-4c27-9751-45b908f34496","paymentMethodAuthorizationId":1,"paymentMethod":{"paymentMethodId":1,"billingAddressId":1,"billingAddress":{"addressId":1,"addressLine1":"1 Default Street","addressLine2":null,"city":"Los Angeles","state":"CA","postalCode":"90210","phoneNumber":null,"email":null,"country":"US"},"billingFirstName":"John","billingLastName":"Doe","merchantPaymentMethodRefId":"custom-payment-method-ref-id-001","paymentMethodAchDetails":null,"paymentMethodCreditCardDetails":{"binNumber":"411111","paymentLast4Digit":"1111","paymentExpirationDate":"0835","accountUpdateMessage":null,"accountUpdateDateTime":null,"accountUpdateCode":null,"paymentAccountNumber":null}},"paymentProcessor":"WorldPay","processorMerchantId":"10071676","responseMessage":"Approved","responseCode":"000","rawResponse":null,"message":"Approved","processorResponseDateTime":null,"authCode":null,"processorTransactionId":null,"revolv3ResponseCode":null,"revolv3ResponseMessage":null,"merchantInvoiceRefId":"1234-5678-9101"}},"Failed authorization":{"title":"Failed authorization","value":{"networkTransactionId":"5e0a6f27-a748-4c11-b203-9fbfc9b08611","paymentMethodAuthorizationId":null,"paymentMethod":{"paymentMethodId":1,"billingAddressId":1,"billingAddress":{"addressId":1,"addressLine1":"1 Default Street","addressLine2":null,"city":"Los Angeles","state":"CA","postalCode":"90210","phoneNumber":null,"email":null,"country":"US"},"billingFirstName":"John","billingLastName":"Doe","merchantPaymentMethodRefId":"custom-payment-method-ref-id-001","paymentMethodAchDetails":null,"paymentMethodCreditCardDetails":{"binNumber":"411111","paymentLast4Digit":"1111","paymentExpirationDate":"0835","accountUpdateMessage":null,"accountUpdateDateTime":null,"accountUpdateCode":null,"paymentAccountNumber":null}},"paymentProcessor":"WorldPay","processorMerchantId":"10071676","responseMessage":"Pick Up Card","responseCode":"303","rawResponse":null,"message":"Pick Up Card. Unable to authorize payment for payment method 1; Transaction Id: 3.","processorResponseDateTime":null,"authCode":null,"processorTransactionId":null,"revolv3ResponseCode":null,"revolv3ResponseMessage":null,"merchantInvoiceRefId":"1234-5678-9101"}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","properties":{"networkTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"The identifier returned for Visa, Mastercard, and Discover transactions. Visa and Discover use this value to link subsequent payments in a recurring/installment stream back to the initial transaction.\r\nYou must include this value in the request message (**originalNetworkTransactionId** element) for subsequent recurring payments.","uniqueKey":"networkTransactionId","typeLabel":"string"},"paymentMethodAuthorizationId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"Unique identifier for a previously pre-authorized payment method.","format":"int64","uniqueKey":"paymentMethodAuthorizationId","typeLabel":"integer\u003cint64>"},"paymentMethod":{"type":"object","description":"The payment method information for the payment.","properties":{"paymentMethodId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier for the payment method information.","format":"int64","uniqueKey":"paymentMethod.paymentMethodId","typeLabel":"integer\u003cint64>"},"billingAddressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"paymentMethod.billingAddressId","typeLabel":"integer\u003cint64>"},"billingAddress":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"paymentMethod.billingAddress.addressId","typeLabel":"integer\u003cint64>"},"addressLine1":{"oneOf":[{"maxLength":40,"minLength":2,"type":"string","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":40,"minLength":2,"type":"null","description":"Address.","uniqueKey":"paymentMethod.billingAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":40,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"paymentMethod.billingAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":25,"minLength":2,"type":"string","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":25,"minLength":2,"type":"null","description":"City.","uniqueKey":"paymentMethod.billingAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Two-letter state abbreviation.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Two-letter state abbreviation.","uniqueKey":"paymentMethod.billingAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"paymentMethod.billingAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.postalCode","typeLabel":"string | null"},"phoneNumber":{"maxLength":20,"minLength":0,"type":"string","description":"The phone number associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"paymentMethod.billingAddress.email","typeLabel":"string\u003cemail>"},"country":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Country.","uniqueKey":"paymentMethod.billingAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Country.","uniqueKey":"paymentMethod.billingAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod.billingAddress","typeLabel":"object"},"billingFirstName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentMethod.billingFirstName.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentMethod.billingFirstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingFirstName","typeLabel":"string | null"},"billingLastName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"paymentMethod.billingLastName.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"paymentMethod.billingLastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.billingLastName","typeLabel":"string | null"},"merchantPaymentMethodRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"paymentMethod.merchantPaymentMethodRefId","typeLabel":"string"},"paymentMethodAchDetails":{"oneOf":[{"type":"object","description":"ACH account information.","properties":{"accountNumberLast4Digits":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Last 4 digits of the bank account.","uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.0.accountNumberLast4Digits","typeLabel":"string"},"accountNumberLength":{"maximum":17,"minimum":4,"type":"integer","description":"Bank account number length.","format":"int32","uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.0.accountNumberLength","typeLabel":"integer\u003cint32>"},"accountType":{"maxLength":8,"minLength":0,"pattern":"^(Checking|Savings)$","type":"string","description":"**Conditional**: the account type is required if the ACH payment method type is supplied in the request.\r\n\r\nBank account type. Allowed values: Checking, Savings. Case-insensitive.","uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.0.accountType","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.0","typeLabel":"object"},{"type":"null","description":"ACH account information.","properties":{"accountNumberLast4Digits":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Last 4 digits of the bank account."},"accountNumberLength":{"maximum":17,"minimum":4,"type":"integer","description":"Bank account number length.","format":"int32"},"accountType":{"maxLength":8,"minLength":0,"pattern":"^(Checking|Savings)$","type":"string","description":"**Conditional**: the account type is required if the ACH payment method type is supplied in the request.\r\n\r\nBank account type. Allowed values: Checking, Savings. Case-insensitive."}},"additionalProperties":false,"uniqueKey":"paymentMethod.paymentMethodAchDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodAchDetails","typeLabel":"object | null"},"paymentMethodCreditCardDetails":{"oneOf":[{"type":"object","description":"The details of credit card payment method.","properties":{"binNumber":{"maxLength":6,"minLength":0,"pattern":"^\\d{1,6}$","type":"string","description":"First 6 digits (BIN) of the card number.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.binNumber","typeLabel":"string"},"paymentLast4Digit":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Payment card last 4 digits.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentLast4Digit","typeLabel":"string"},"paymentExpirationDate":{"oneOf":[{"maxLength":4,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate.oneOf.0","typeLabel":"string\u003cMMYY>"},{"maxLength":4,"minLength":0,"type":"null","description":"The card expiration date.","format":"MMYY","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate","typeLabel":"string\u003cMMYY> | null"},"accountUpdateMessage":{"maxLength":500,"minLength":0,"type":"string","description":"Account updater message, if available.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateMessage","typeLabel":"string"},"accountUpdateDateTime":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","description":"UTC date-time of the last account updater event.","format":"YYYY-MM-DDThh:mm:ss","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateDateTime.oneOf.0","typeLabel":"string\u003cYYYY-MM-DDThh:mm:ss>"},{"maxLength":20,"minLength":0,"type":"null","description":"UTC date-time of the last account updater event.","format":"YYYY-MM-DDThh:mm:ss","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateDateTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateDateTime","typeLabel":"string\u003cYYYY-MM-DDThh:mm:ss> | null"},"accountUpdateCode":{"maxLength":50,"minLength":0,"type":"string","description":"Processor response code of the last account updater event.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateCode","typeLabel":"string"},"paymentAccountNumber":{"oneOf":[{"type":"string","description":"The full unmasked card number. Only populated for merchants verified as PCI DSS Level 1 and only in case account updater performed.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"The full unmasked card number. Only populated for merchants verified as PCI DSS Level 1 and only in case account updater performed.","uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.0","typeLabel":"object"},{"type":"null","description":"The details of credit card payment method.","properties":{"binNumber":{"maxLength":6,"minLength":0,"pattern":"^\\d{1,6}$","type":"string","description":"First 6 digits (BIN) of the card number."},"paymentLast4Digit":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Payment card last 4 digits."},"paymentExpirationDate":{"oneOf":[{"maxLength":4,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY"},{"maxLength":4,"minLength":0,"type":"null","description":"The card expiration date.","format":"MMYY"}]},"accountUpdateMessage":{"maxLength":500,"minLength":0,"type":"string","description":"Account updater message, if available."},"accountUpdateDateTime":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","description":"UTC date-time of the last account updater event.","format":"YYYY-MM-DDThh:mm:ss"},{"maxLength":20,"minLength":0,"type":"null","description":"UTC date-time of the last account updater event.","format":"YYYY-MM-DDThh:mm:ss"}]},"accountUpdateCode":{"maxLength":50,"minLength":0,"type":"string","description":"Processor response code of the last account updater event."},"paymentAccountNumber":{"oneOf":[{"type":"string","description":"The full unmasked card number. Only populated for merchants verified as PCI DSS Level 1 and only in case account updater performed."},{"type":"null","description":"The full unmasked card number. Only populated for merchants verified as PCI DSS Level 1 and only in case account updater performed."}]}},"additionalProperties":false,"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"paymentMethod.paymentMethodCreditCardDetails","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"paymentMethod","typeLabel":"object"},"paymentProcessor":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the processor by which the transaction was processed.","uniqueKey":"paymentProcessor","typeLabel":"string"},"processorMerchantId":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant account ID (MID) of the processor by which the transaction was processed.","uniqueKey":"processorMerchantId","typeLabel":"string"},"responseMessage":{"maxLength":500,"minLength":0,"type":"string","description":"The processor response message.","uniqueKey":"responseMessage","typeLabel":"string"},"responseCode":{"maxLength":10,"minLength":0,"type":"string","description":"The processor response code.","uniqueKey":"responseCode","typeLabel":"string"},"rawResponse":{"maxLength":10000,"minLength":0,"type":"string","description":"**Conditional. The value is returned if includeRawProcessorResponse = true.**\r\nThis field contains the raw data received from the processor after attempting to bill this payment. It does not contain any sensitive information. The field value is a string with the serialized response from the processor in JSON format.","uniqueKey":"rawResponse","typeLabel":"string"},"message":{"maxLength":500,"minLength":0,"type":"string","description":"The message returned directly from payment processor or a special message provided by system. ","uniqueKey":"message","typeLabel":"string"},"processorResponseDateTime":{"maxLength":40,"type":"string","description":"UTC timestamp of the payment processor response (format: YYYY-MM-DDThh:mm:ss).","format":"date-time","uniqueKey":"processorResponseDateTime","typeLabel":"string\u003cdate-time>"},"authCode":{"maxLength":20,"minLength":0,"type":"string","description":"Transaction authorization code.","uniqueKey":"authCode","typeLabel":"string"},"processorTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Payment Processor Transaction Id.","uniqueKey":"processorTransactionId","typeLabel":"string"},"revolv3ResponseCode":{"maxLength":10,"minLength":0,"type":"string","description":"Standardized internal response code indicating the outcome of the request.","uniqueKey":"revolv3ResponseCode","typeLabel":"string"},"revolv3ResponseMessage":{"maxLength":500,"minLength":0,"type":"string","description":"Message providing additional details about the response code.","uniqueKey":"revolv3ResponseMessage","typeLabel":"string"},"merchantInvoiceRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the invoice.","uniqueKey":"merchantInvoiceRefId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Approved authorization":{"title":"Approved authorization","value":{"networkTransactionId":"13d5c9b9-3a2a-4c27-9751-45b908f34496","paymentMethodAuthorizationId":1,"paymentMethod":{"paymentMethodId":1,"billingAddressId":1,"billingAddress":{"addressId":1,"addressLine1":"1 Default Street","addressLine2":null,"city":"Los Angeles","state":"CA","postalCode":"90210","phoneNumber":null,"email":null,"country":"US"},"billingFirstName":"John","billingLastName":"Doe","merchantPaymentMethodRefId":"custom-payment-method-ref-id-001","paymentMethodAchDetails":null,"paymentMethodCreditCardDetails":{"binNumber":"411111","paymentLast4Digit":"1111","paymentExpirationDate":"0835","accountUpdateMessage":null,"accountUpdateDateTime":null,"accountUpdateCode":null,"paymentAccountNumber":null}},"paymentProcessor":"WorldPay","processorMerchantId":"10071676","responseMessage":"Approved","responseCode":"000","rawResponse":null,"message":"Approved","processorResponseDateTime":null,"authCode":null,"processorTransactionId":null,"revolv3ResponseCode":null,"revolv3ResponseMessage":null,"merchantInvoiceRefId":"1234-5678-9101"}},"Failed authorization":{"title":"Failed authorization","value":{"networkTransactionId":"5e0a6f27-a748-4c11-b203-9fbfc9b08611","paymentMethodAuthorizationId":null,"paymentMethod":{"paymentMethodId":1,"billingAddressId":1,"billingAddress":{"addressId":1,"addressLine1":"1 Default Street","addressLine2":null,"city":"Los Angeles","state":"CA","postalCode":"90210","phoneNumber":null,"email":null,"country":"US"},"billingFirstName":"John","billingLastName":"Doe","merchantPaymentMethodRefId":"custom-payment-method-ref-id-001","paymentMethodAchDetails":null,"paymentMethodCreditCardDetails":{"binNumber":"411111","paymentLast4Digit":"1111","paymentExpirationDate":"0835","accountUpdateMessage":null,"accountUpdateDateTime":null,"accountUpdateCode":null,"paymentAccountNumber":null}},"paymentProcessor":"WorldPay","processorMerchantId":"10071676","responseMessage":"Pick Up Card","responseCode":"303","rawResponse":null,"message":"Pick Up Card. Unable to authorize payment for payment method 1; Transaction Id: 3.","processorResponseDateTime":null,"authCode":null,"processorTransactionId":null,"revolv3ResponseCode":null,"revolv3ResponseMessage":null,"merchantInvoiceRefId":"1234-5678-9101"}}},"exampleType":"examples"}},"exampleType":"examples"},"c33f8024-3705-45d6-822d-2a35fb8336ca":{"description":"Bad Request","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Generic error":{"title":"Generic error","value":{"message":"ACCT LENGTH ERR. Unable to authorize payment for payment method 226452; Transaction Id: 789426."}},"Validation error":{"title":"Validation error","value":{"message":"One or more validation failed.","errors":["Can't find active PaymentMethod '52'"],"fluentValidatorErrors":[{"propertyName":"","errorMessage":"Can't find active PaymentMethod '52'","attemptedValue":null,"customState":null,"severity":"Error","errorCode":null,"formattedMessagePlaceholderValues":null}]}}},"exampleType":"examples"},"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Generic error":{"title":"Generic error","value":{"message":"ACCT LENGTH ERR. Unable to authorize payment for payment method 226452; Transaction Id: 789426."}},"Validation error":{"title":"Validation error","value":{"message":"One or more validation failed.","errors":["Can't find active PaymentMethod '52'"],"fluentValidatorErrors":[{"propertyName":"","errorMessage":"Can't find active PaymentMethod '52'","attemptedValue":null,"customState":null,"severity":"Error","errorCode":null,"formattedMessagePlaceholderValues":null}]}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Generic error":{"title":"Generic error","value":{"message":"ACCT LENGTH ERR. Unable to authorize payment for payment method 226452; Transaction Id: 789426."}},"Validation error":{"title":"Validation error","value":{"message":"One or more validation failed.","errors":["Can't find active PaymentMethod '52'"],"fluentValidatorErrors":[{"propertyName":"","errorMessage":"Can't find active PaymentMethod '52'","attemptedValue":null,"customState":null,"severity":"Error","errorCode":null,"formattedMessagePlaceholderValues":null}]}}},"exampleType":"examples"}},"exampleType":"examples"},"a99bbbbe-3daa-4e48-8679-a2c6d75b8aaa":{"description":"Unauthorized","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Attempted to perform an unauthorized operation."},"examples":{"Example":{"title":"Example","value":{"message":"Attempted to perform an unauthorized operation."}}},"exampleType":"examples"},"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Attempted to perform an unauthorized operation."},"examples":{"Example":{"title":"Example","value":{"message":"Attempted to perform an unauthorized operation."}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Attempted to perform an unauthorized operation."},"examples":{"Example":{"title":"Example","value":{"message":"Attempted to perform an unauthorized operation."}}},"exampleType":"examples"}},"exampleType":"examples"},"3fab48df-d8a6-497c-af54-e3edde4a7646":{"description":"Unprocessable Content","content":{"text/plain":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unable to process this operation."},"examples":{"Example":{"title":"Example","value":{"message":"Unable to process this operation."}}},"exampleType":"examples"},"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unable to process this operation."},"examples":{"Example":{"title":"Example","value":{"message":"Unable to process this operation."}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.1","typeLabel":"null"}],"uniqueKey":"message","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"string[] | null"},"fluentValidatorErrors":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].propertyName","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorMessage","typeLabel":"string | null"},"attemptedValue":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].attemptedValue","typeLabel":"null"},"customState":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].customState","typeLabel":"null"},"severity":{"enum":["Error","Warning","Info"],"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"errorCode":{"oneOf":[{"type":"string","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].errorCode","typeLabel":"string | null"},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX].formattedMessagePlaceholderValues","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"fluentValidatorErrors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fluentValidatorErrors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"propertyName":{"oneOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"attemptedValue":{"oneOf":[{},{"type":"null"}]},"customState":{"oneOf":[{},{"type":"null"}]},"severity":{"enum":["Error","Warning","Info"],"type":"string"},"errorCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"formattedMessagePlaceholderValues":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null"}]}},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null"}]}}]}},"additionalProperties":false},"uniqueKey":"fluentValidatorErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"fluentValidatorErrors","typeLabel":"object[] | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unable to process this operation."},"examples":{"Example":{"title":"Example","value":{"message":"Unable to process this operation."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"095935e6-3511-40c7-a652-3d9cc8350703":{"XRevolv3Token":{"type":"apiKey","in":"header","name":"x-revolv3-token","scopes":[],"schemeName":"XRevolv3Token"}}},"servers":{"334e6eb5-634d-46b6-90d2-b0f4797cf87a":{"url":"https://api-sandbox.revolv3.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-revolv3-token","scopes":[],"schemeName":"XRevolv3Token"},"schema":{"title":"x-revolv3-token","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"XRevolv3Token","name":"x-revolv3-token"}],"title":"XRevolv3Token"}]},"originalFileLocation":"api-reference/swagger.json"},"subdomain":"revolv3","siteName":"Introduction \u0026 Quick Start","title":"Authorize With Payment Method Id - Introduction \u0026 Quick Start","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-13T22:34:17.993Z","originalFileLocation":"api-reference/payments/authorize-with-payment-method-id.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=\"Performs a payment authorization using a previously stored payment method, referenced by its unique ID. The funds are held on the customer’s account but not captured immediately. This endpoint is typically used in multi-step checkout flows, bookings, or delayed fulfillment scenarios. It improves security and UX by leveraging saved payment methods, eliminating the need to re-enter payment data. The authorization can later be captured using the Capture endpoint or voided via Reverse Authorization. Related Links: Network Processing Types Dynamic Descriptor Guide Order Processing Channel\">\u003cmeta data-mint-head name=\"application-name\" content=\"Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_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/revolv3/SEFZpst3yZfiH2vQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authorize With Payment Method Id - Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head property=\"og:description\" content=\"Performs a payment authorization using a previously stored payment method, referenced by its unique ID. The funds are held on the customer’s account but not captured immediately. This endpoint is typically used in multi-step checkout flows, bookings, or delayed fulfillment scenarios. It improves security and UX by leveraging saved payment methods, eliminating the need to re-enter payment data. The authorization can later be captured using the Capture endpoint or voided via Reverse Authorization. Related Links: Network Processing Types Dynamic Descriptor Guide Order Processing Channel\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.revolv3.com/api-reference/payments/authorize-with-payment-method-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://revolv3.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Authorize+With+Payment+Method+Id\u0026amp;description=Performs+a+**payment+authorization**+using+a+previously+stored+payment+method%2C+referenced+by+its+unique+ID.%0D%0AThe+funds+are+held+on+the+customer%E2%80%99s+account+but+**\u0026amp;theme=44ecc26a32f1a478fe3476c2\u0026amp;signature=422107192d488bbca94e82e4099b0cc96811702b88b6bc2feacf94bd51475510\">\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=\"Authorize With Payment Method Id - Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Performs a payment authorization using a previously stored payment method, referenced by its unique ID. The funds are held on the customer’s account but not captured immediately. This endpoint is typically used in multi-step checkout flows, bookings, or delayed fulfillment scenarios. It improves security and UX by leveraging saved payment methods, eliminating the need to re-enter payment data. The authorization can later be captured using the Capture endpoint or voided via Reverse Authorization. Related Links: Network Processing Types Dynamic Descriptor Guide Order Processing Channel\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://revolv3.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Authorize+With+Payment+Method+Id\u0026amp;description=Performs+a+**payment+authorization**+using+a+previously+stored+payment+method%2C+referenced+by+its+unique+ID.%0D%0AThe+funds+are+held+on+the+customer%E2%80%99s+account+but+**\u0026amp;theme=44ecc26a32f1a478fe3476c2\u0026amp;signature=422107192d488bbca94e82e4099b0cc96811702b88b6bc2feacf94bd51475510\">\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/revolv3/SEFZpst3yZfiH2vQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0070e0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.revolv3.com/api-reference/payments/authorize-with-payment-method-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payments/authorize-with-payment-method-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.revolv3.com/#organization\",\"name\":\"Introduction \u0026 Quick Start\",\"url\":\"https://docs.revolv3.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/revolv3/Zevkr_Aqagg8mPcq/logo/normallogo.png?fit=max\u0026auto=format\u0026n=Zevkr_Aqagg8mPcq\u0026q=85\u0026s=fd4c62503540a031e3c6c968fad23f13\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.revolv3.com#website\",\"name\":\"Introduction \u0026 Quick Start\",\"url\":\"https://docs.revolv3.com\",\"publisher\":{\"@id\":\"https://docs.revolv3.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.revolv3.com/api-reference/payments/authorize-with-payment-method-id#webpage\",\"url\":\"https://docs.revolv3.com/api-reference/payments/authorize-with-payment-method-id\",\"name\":\"Authorize With Payment Method Id\",\"description\":\"Performs a payment authorization using a previously stored payment method, referenced by its unique ID. The funds are held on the customer’s account but not captured immediately. This endpoint is typically used in multi-step checkout flows, bookings, or delayed fulfillment scenarios. It improves security and UX by leveraging saved payment methods, eliminating the need to re-enter payment data. The authorization can later be captured using the Capture endpoint or voided via Reverse Authorization. Related Links: Network Processing Types Dynamic Descriptor Guide Order Processing Channel\",\"dateModified\":\"2026-10-13T22:34:17.993Z\",\"isPartOf\":{\"@id\":\"https://docs.revolv3.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.revolv3.com/api-reference/payments/authorize-with-payment-method-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.revolv3.com/api-reference/payments/authorize-with-payment-method-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments\",\"item\":\"https://docs.revolv3.com/api-reference/payments/sale-with-payment-method-details\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authorize With Payment Method Id\",\"item\":\"https://docs.revolv3.com/api-reference/payments/authorize-with-payment-method-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.revolv3.com/api-reference/payments/authorize-with-payment-method-id#apireference\",\"headline\":\"Authorize With Payment Method Id\",\"name\":\"Authorize With Payment Method Id\",\"description\":\"Performs a payment authorization using a previously stored payment method, referenced by its unique ID. The funds are held on the customer’s account but not captured immediately. This endpoint is typically used in multi-step checkout flows, bookings, or delayed fulfillment scenarios. It improves security and UX by leveraging saved payment methods, eliminating the need to re-enter payment data. The authorization can later be captured using the Capture endpoint or voided via Reverse Authorization. Related Links: Network Processing Types Dynamic Descriptor Guide Order Processing Channel\",\"url\":\"https://docs.revolv3.com/api-reference/payments/authorize-with-payment-method-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.revolv3.com/api-reference/payments/authorize-with-payment-method-id#webpage\"},\"dateModified\":\"2026-10-13T22:34:17.993Z\",\"publisher\":{\"@id\":\"https://docs.revolv3.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.revolv3.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Introduction \u0026 Quick Start\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Introduction \u0026 Quick Start","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/getting-started/getting-started"}]},{"tab":"API Reference","groups":[{"group":"AccountVerification","pages":[{"title":"Validate personal ACH account","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/account-verification/ach/person","href":"/api-reference/accountverification/validate-personal-ach-account"},{"title":"Validate corporate ACH account","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/account-verification/ach/corporate","href":"/api-reference/accountverification/validate-corporate-ach-account"}]},{"group":"Authentication","pages":[{"title":"Get Merchant Access Token","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Authentication/token","href":"/api-reference/authentication/get-merchant-access-token"}]},{"group":"Checkout","pages":[{"title":"Create Checkout Link","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Checkout","href":"/api-reference/checkout/create-checkout-link"},{"title":"Get Complete Checkout Information","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Checkout/{checkoutUid}","href":"/api-reference/checkout/get-complete-checkout-information"}]},{"group":"Customers","pages":[{"title":"Get Customers","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Customers","href":"/api-reference/customers/get-customers"},{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Customers","href":"/api-reference/customers/create-customer"},{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Customers/{customerId}","href":"/api-reference/customers/get-customer"},{"title":"Delete Customer","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json delete /api/Customers/{customerId}","href":"/api-reference/customers/delete-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json patch /api/Customers/{customerId}","href":"/api-reference/customers/update-customer"},{"title":"Get Subscriptions by Customer","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Customers/{customerId}/subscriptions","href":"/api-reference/customers/get-subscriptions-by-customer"},{"title":"Delete Customer Address","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json delete /api/Customers/{customerId}/address/{addressId}","href":"/api-reference/customers/delete-customer-address"},{"title":"Update Address","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json patch /api/Customers/{customerId}/address/{addressId}","href":"/api-reference/customers/update-address"},{"title":"Add Customer Address","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Customers/{customerId}/address","href":"/api-reference/customers/add-customer-address"},{"title":"Search Invoices for Customer","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Customers/{customerId}/invoices","href":"/api-reference/customers/search-invoices-for-customer"}]},{"group":"Invoices","pages":[{"title":"Get Invoices","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Invoices","href":"/api-reference/invoices/get-invoices"},{"title":"Get Invoices V1","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Invoices/v{version}","href":"/api-reference/invoices/get-invoices-v1"},{"title":"Get Invoice","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Invoices/{invoiceId}","href":"/api-reference/invoices/get-invoice"},{"title":"Refund Invoice","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Invoices/{invoiceId}/refund","href":"/api-reference/invoices/refund-invoice"},{"title":"One Time Payment Without Subscription","deprecated":true,"version":null,"openapi":"/api-reference/swagger.json post /api/Invoices/payment","href":"/api-reference/invoices/one-time-payment-without-subscription"}]},{"group":"PaymentMethod","pages":[{"title":"Create Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/PaymentMethod","href":"/api-reference/paymentmethod/create-payment-method"},{"title":"Get Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/PaymentMethod/{paymentMethodId}","href":"/api-reference/paymentmethod/get-payment-method"},{"title":"Delete Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json delete /api/PaymentMethod/{paymentMethodId}","href":"/api-reference/paymentmethod/delete-payment-method"},{"title":"Update Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json patch /api/PaymentMethod/{paymentMethodId}","href":"/api-reference/paymentmethod/update-payment-method"},{"title":"Authorize Payment Method","deprecated":true,"version":null,"openapi":"/api-reference/swagger.json post /api/PaymentMethod/authorize","href":"/api-reference/paymentmethod/authorize-payment-method"},{"title":"Reverse Authorization","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/PaymentMethod/reverse-auth","href":"/api-reference/paymentmethod/reverse-authorization"}]},{"group":"Payments","pages":[{"title":"Sale With Payment Method Details","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/sale","href":"/api-reference/payments/sale-with-payment-method-details"},{"title":"Sale With Payment Method Id","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/sale/{paymentMethodId}","href":"/api-reference/payments/sale-with-payment-method-id"},{"title":"Capture","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/capture/{paymentMethodAuthorizationId}","href":"/api-reference/payments/capture"},{"title":"Authorize With Payment Method Details","description":"Performs a **payment authorization** using raw payment method details (e.g., card number, expiration date, CVV, or bank account info), without capturing the funds immediately.\r\nThis is typically used when you want to place a hold on the customer’s account — for example, to confirm availability of funds before fulfillment or booking.\r\n\r\nYou must provide the full payment data along with invoice details.\r\nThe payment is validated with the processor, and if successful, an authorization is created and stored for later capture or reversal.\r\n\r\nThis endpoint is intended for **PCI-compliant merchants**, as it involves transmitting sensitive payment data directly.\r\n\r\nThe authorization can later be captured using the \u003ca href=\"/api-reference/payments/capture\">Capture\u003c/a> endpoint or voided via \u003ca href=\"/api-reference/paymentmethod/reverse-authorization\">Reverse Authorization\u003c/a>.","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/authorization","href":"/api-reference/payments/authorize-with-payment-method-details"},{"title":"Authorize With Payment Method Id","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/authorization/{paymentMethodId}","href":"/api-reference/payments/authorize-with-payment-method-id"},{"title":"Void","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Payments/void/{invoiceId}","href":"/api-reference/payments/void"}]},{"group":"Subscriptions","pages":[{"title":"Get Subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Subscriptions","href":"/api-reference/subscriptions/get-subscriptions"},{"title":"Create Subscription","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Subscriptions","href":"/api-reference/subscriptions/create-subscription"},{"title":"Get Subscription","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Subscriptions/{subscriptionId}","href":"/api-reference/subscriptions/get-subscription"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json patch /api/Subscriptions/{subscriptionId}","href":"/api-reference/subscriptions/update-subscription"},{"title":"Get Subscriptions By PAN","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Subscriptions/pan-lookup","href":"/api-reference/subscriptions/get-subscriptions-by-pan"},{"title":"Replace Subscription Primary Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json put /api/Subscriptions/{subscriptionId}/payment-method","href":"/api-reference/subscriptions/replace-subscription-primary-payment-method"},{"title":"Create Subscription Billing Plan","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Subscriptions/{subscriptionId}/billing-plans","href":"/api-reference/subscriptions/create-subscription-billing-plan"},{"title":"Delete Subscription Billing Plan","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json delete /api/Subscriptions/{subscriptionId}/billing-plans/{subscriptionBillingPlanId}","href":"/api-reference/subscriptions/delete-subscription-billing-plan"},{"title":"Create One Time Payment","deprecated":true,"version":null,"openapi":"/api-reference/swagger.json post /api/Subscriptions/{subscriptionId}/payment","href":"/api-reference/subscriptions/create-one-time-payment"},{"title":"Cancel Subscription","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json post /api/Subscriptions/{subscriptionId}/cancel","href":"/api-reference/subscriptions/cancel-subscription"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Authorize With Payment Method Id - Introduction \u0026 Quick Start","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}