{
"message": "Attempted to perform an unauthorized operation."
}
{
"message": "Unable to find an entity with the provided data."
}
Invoices
Get Invoice
Retrieves detailed information about a specific invoice using its unique invoice ID.
This endpoint returns invoice metadata, payment status, amount, associated payment method references, and timestamps related to invoice attempts.
It’s ideal when you already know the invoice ID and need to fetch its full details for display, audit, or troubleshooting purposes.
Supports use cases like viewing a transaction in the portal or validating an invoice after a payment operation.
Optionally, you can set includeRawProcessorResponse = true to include the raw response returned from the payment processor, which can help with advanced debugging or support cases.
GET
/
api
/
Invoices
/
{invoiceId}
Get Invoice
curl --request GET \ --url https://api-sandbox.revolv3.com/api/Invoices/{invoiceId} \ --header 'x-revolv3-token: <api-key>'
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.
{"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/invoices/get-invoice","slug":"/api-reference/invoices/get-invoice","pageMetadata":{"title":"Get Invoice","description":"Retrieves detailed information about a **specific invoice** using its unique invoice ID.\r\nThis endpoint returns invoice metadata, payment status, amount, associated payment method references, and timestamps related to invoice attempts.\r\n\r\nIt’s ideal when you already know the invoice ID and need to fetch its full details for display, audit, or troubleshooting purposes.\r\nSupports use cases like viewing a transaction in the portal or validating an invoice after a payment operation.\r\n\r\nOptionally, you can set **includeRawProcessorResponse = true** to include the raw response returned from the payment processor, which can help with advanced debugging or support cases.","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Invoices/{invoiceId}","href":"/api-reference/invoices/get-invoice","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: [\"Retrieves detailed information about a \", _jsx(_components.strong, {\n children: \"specific invoice\"\n }), \" using its unique invoice ID.\\r\\nThis endpoint returns invoice metadata, payment status, amount, associated payment method references, and timestamps related to invoice attempts.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"It’s ideal when you already know the invoice ID and need to fetch its full details for display, audit, or troubleshooting purposes.\\r\\nSupports use cases like viewing a transaction in the portal or validating an invoice after a payment operation.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Optionally, you can set \", _jsx(_components.strong, {\n children: \"includeRawProcessorResponse = true\"\n }), \" to include the raw response returned from the payment processor, which can help with advanced debugging or support cases.\"]\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":"Get Invoice","description":"Retrieves detailed information about a **specific invoice** using its unique invoice ID.\r\nThis endpoint returns invoice metadata, payment status, amount, associated payment method references, and timestamps related to invoice attempts.\r\n\r\nIt’s ideal when you already know the invoice ID and need to fetch its full details for display, audit, or troubleshooting purposes.\r\nSupports use cases like viewing a transaction in the portal or validating an invoice after a payment operation.\r\n\r\nOptionally, you can set **includeRawProcessorResponse = true** to include the raw response returned from the payment processor, which can help with advanced debugging or support cases.","deprecated":null,"version":null,"openapi":"/api-reference/swagger.json get /api/Invoices/{invoiceId}","href":"/api-reference/invoices/get-invoice","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/revolv3/b2e6669526e8a41b/scripts/fix-swagger-auth.js"],"openApiReferenceData":{"operation":{"tags":["Invoices"],"summary":"Get Invoice","description":"Retrieves detailed information about a **specific invoice** using its unique invoice ID.\r\nThis endpoint returns invoice metadata, payment status, amount, associated payment method references, and timestamps related to invoice attempts.\r\n\r\nIt’s ideal when you already know the invoice ID and need to fetch its full details for display, audit, or troubleshooting purposes.\r\nSupports use cases like viewing a transaction in the portal or validating an invoice after a payment operation.\r\n\r\nOptionally, you can set **includeRawProcessorResponse = true** to include the raw response returned from the payment processor, which can help with advanced debugging or support cases.","parameters":["d8eb9817-a307-4bd6-b7f2-cfeec8be7ec4","fd7e2185-bcb9-4299-9974-95aad25f3ca1"],"responses":{"200":"ad3645e9-e014-43e0-840c-0453377e9ef3","401":"a2c43993-eb04-4525-8d57-01b8353b8b96","404":"12436dea-a4ff-4c5f-8cc4-7a5129121c2e"},"security":["e41f5236-e293-4e70-a1c9-570b882f4334"],"method":"get","type":"path","servers":["334e6eb5-634d-46b6-90d2-b0f4797cf87a"],"path":"/api/Invoices/{invoiceId}","baseUrlOptions":["https://api-sandbox.revolv3.com"],"title":"Get Invoice","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d8eb9817-a307-4bd6-b7f2-cfeec8be7ec4":{"name":"invoiceId","in":"path","description":"The unique identifier of the invoice.","required":true,"schema":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","isRequired":true,"description":"The unique identifier of the invoice.","uniqueKey":"","typeLabel":"integer\u003cint64>"}},"fd7e2185-bcb9-4299-9974-95aad25f3ca1":{"name":"includeRawProcessorResponse","in":"query","description":"Determine whether to return raw processor data in the response.","schema":{"type":"boolean","default":false,"description":"Determine whether to return raw processor data in the response.","uniqueKey":"","typeLabel":"boolean"}}},"responses":{"ad3645e9-e014-43e0-840c-0453377e9ef3":{"description":"OK","content":{"text/plain":{"schema":{"type":"object","properties":{"invoiceId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the invoice.","format":"int64","uniqueKey":"invoiceId","typeLabel":"integer\u003cint64>"},"parentInvoiceId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"parentInvoiceId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"parentInvoiceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"parentInvoiceId","typeLabel":"integer\u003cint64> | null"},"customerId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the customer.","format":"int64","uniqueKey":"customerId","typeLabel":"integer\u003cint64>"},"merchantInvoiceRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the invoice.","uniqueKey":"merchantInvoiceRefId","typeLabel":"string"},"paymentMethod":{"type":"object","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>"},"billingFirstName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s first name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingFirstName","typeLabel":"string"},"billingLastName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s last name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingLastName","typeLabel":"string"},"merchantPaymentMethodRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"paymentMethod.merchantPaymentMethodRefId","typeLabel":"string"},"billingAddress":{"type":"object","description":"The address associated with a payment method that is used for billing purposes. Either an Address ID or detailed address information can be provided.","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"},"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"},"invoiceStatus":{"maxLength":100,"minLength":0,"type":"string","description":"The current status of the invoice.\r\n\r\nPossible values: `Paid`, `Pending`, `Noncollectable`, `Failed`, `OneTimePaymentPending`, `RetryPending`.","uniqueKey":"invoiceStatus","typeLabel":"string"},"subtotal":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"subtotal","typeLabel":"number\u003cdouble>"},"tax":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"tax","typeLabel":"number\u003cdouble>"},"total":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"total","typeLabel":"number\u003cdouble>"},"billingDate":{"maxLength":20,"minLength":0,"type":"string","description":"The day on which the last billing was attempted for the invoice","uniqueKey":"billingDate","typeLabel":"string"},"merchantLegalName":{"oneOf":[{"maxLength":200,"minLength":0,"type":"string","uniqueKey":"merchantLegalName.oneOf.0","typeLabel":"string"},{"maxLength":200,"minLength":0,"type":"null","uniqueKey":"merchantLegalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantLegalName","typeLabel":"string | null"},"merchantCustomerRefId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"merchantCustomerRefId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"merchantCustomerRefId.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantCustomerRefId","typeLabel":"string | null"},"customerFirstName":{"oneOf":[{"maxLength":150,"minLength":0,"type":"string","uniqueKey":"customerFirstName.oneOf.0","typeLabel":"string"},{"maxLength":150,"minLength":0,"type":"null","uniqueKey":"customerFirstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerFirstName","typeLabel":"string | null"},"customerLastName":{"oneOf":[{"maxLength":150,"minLength":0,"type":"string","uniqueKey":"customerLastName.oneOf.0","typeLabel":"string"},{"maxLength":150,"minLength":0,"type":"null","uniqueKey":"customerLastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerLastName","typeLabel":"string | null"},"subscriptionId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"subscriptionId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"subscriptionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptionId","typeLabel":"integer\u003cint64> | null"},"installmentId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"installmentId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"installmentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"installmentId","typeLabel":"integer\u003cint64> | null"},"eligibilityFailReason":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"eligibilityFailReason.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"eligibilityFailReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"eligibilityFailReason","typeLabel":"string | null"},"merchantSubscriptionRefId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"merchantSubscriptionRefId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"merchantSubscriptionRefId.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantSubscriptionRefId","typeLabel":"string | null"},"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"},"currency":{"maxLength":3,"minLength":0,"type":"string","description":"The three-character ISO currency code.\r\n\r\nDefault value: `USD`","uniqueKey":"currency","typeLabel":"string"},"invoiceLineItems":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"invoiceLineItemId":{"maximum":1000000000,"minimum":0,"type":"integer","format":"int64","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].invoiceLineItemId","typeLabel":"integer\u003cint64>"},"name":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"description":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"value":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].value","typeLabel":"number\u003cdouble>"},"valueType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].valueType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].valueType.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].valueType","typeLabel":"string | null"},"billingValueType":{"enum":["Standard","Discount","DiscountPercentage","FinalDiscount","PriceOverride"],"type":"string","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].billingValueType","typeLabel":"enum\u003cstring>"},"invoiceId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the invoice.","format":"int64","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].invoiceId","typeLabel":"integer\u003cint64>"}},"additionalProperties":false,"uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoiceLineItems.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"invoiceLineItemId":{"maximum":1000000000,"minimum":0,"type":"integer","format":"int64"},"name":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string"},{"maxLength":100,"minLength":0,"type":"null"}]},"description":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string"},{"maxLength":500,"minLength":0,"type":"null"}]},"value":{"maximum":10000000,"minimum":0,"type":"number","format":"double"},"valueType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string"},{"maxLength":50,"minLength":0,"type":"null"}]},"billingValueType":{"enum":["Standard","Discount","DiscountPercentage","FinalDiscount","PriceOverride"],"type":"string"},"invoiceId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the invoice.","format":"int64"}},"additionalProperties":false},"uniqueKey":"invoiceLineItems.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceLineItems","typeLabel":"object[] | null"},"invoiceAttempts":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"invoiceAttemptId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].invoiceAttemptId","typeLabel":"integer\u003cint64>"},"amount":{"maximum":10000000,"minimum":0,"type":"number","description":"The amount information for the payment.","format":"double","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].amount","typeLabel":"number\u003cdouble>"},"invoiceAttemptStatus":{"maxLength":100,"minLength":0,"type":"string","description":"The status of the invoice attempt.\r\n\r\nPossible values: `Success`, `Fail`, `Pending`, `RetrySuccess`, `RetryFail`, `RetryPending`.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].invoiceAttemptStatus","typeLabel":"string"},"invoiceAttemptDate":{"type":"string","format":"yyyy-MM-ddTHH:mm:ss.fff","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].invoiceAttemptDate","typeLabel":"string\u003cyyyy-MM-ddTHH:mm:ss.fff>"},"paymentProcessor":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the processor by which the transaction was processed.","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentProcessor","typeLabel":"string"},"processorTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Payment Processor Transaction Id.","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processorTransactionId","typeLabel":"string"},"responseCode":{"maxLength":10,"minLength":0,"type":"string","description":"The processor response code.","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].responseCode","typeLabel":"string"},"responseMessage":{"maxLength":500,"minLength":0,"type":"string","description":"The processor response message.","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].responseMessage","typeLabel":"string"},"processorRawResponse":{"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":"invoiceAttempts.oneOf.0.items.[INDEX].processorRawResponse","typeLabel":"string"},"paymentMethod":{"type":"object","properties":{"paymentMethodId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier for the payment method information.","format":"int64","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodId","typeLabel":"integer\u003cint64>"},"billingAddressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddressId","typeLabel":"integer\u003cint64>"},"billingAddress":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressId","typeLabel":"integer\u003cint64>"},"addressLine1":{"oneOf":[{"maxLength":40,"minLength":2,"type":"string","description":"Address.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":40,"minLength":2,"type":"null","description":"Address.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":40,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":25,"minLength":2,"type":"string","description":"City.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":25,"minLength":2,"type":"null","description":"City.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Two-letter state abbreviation.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Two-letter state abbreviation.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.email","typeLabel":"string\u003cemail>"},"country":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Country.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Country.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress","typeLabel":"object"},"billingFirstName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingFirstName.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingFirstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingFirstName","typeLabel":"string | null"},"billingLastName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingLastName.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingLastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingLastName","typeLabel":"string | null"},"merchantPaymentMethodRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodAchDetails.oneOf.0.accountNumberLast4Digits","typeLabel":"string"},"accountNumberLength":{"maximum":17,"minimum":4,"type":"integer","description":"Bank account number length.","format":"int32","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodAchDetails.oneOf.0.accountType","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodAchDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.binNumber","typeLabel":"string"},"paymentLast4Digit":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Payment card last 4 digits.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentLast4Digit","typeLabel":"string"},"paymentExpirationDate":{"oneOf":[{"maxLength":4,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate.oneOf.0","typeLabel":"string\u003cMMYY>"},{"maxLength":4,"minLength":0,"type":"null","description":"The card expiration date.","format":"MMYY","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate","typeLabel":"string\u003cMMYY> | null"},"accountUpdateMessage":{"maxLength":500,"minLength":0,"type":"string","description":"Account updater message, if available.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateDateTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod","typeLabel":"object"},"descriptor":{"type":"object","properties":{"subMerchantId":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantId","typeLabel":"string | null"},"subMerchantName":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantName","typeLabel":"string | null"},"subMerchantPhone":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantPhone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantPhone.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantPhone","typeLabel":"string | null"},"countryCode":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.countryCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.countryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.countryCode","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.city","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor","typeLabel":"object"},"eligibilityCheckOrderCode":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].eligibilityCheckOrderCode.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].eligibilityCheckOrderCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].eligibilityCheckOrderCode","typeLabel":"string | null"},"processorMerchantId":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant account ID (MID) of the processor by which the transaction was processed.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processorMerchantId","typeLabel":"string"},"processingMethod":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processingMethod.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processingMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processingMethod","typeLabel":"string | null"},"revolv3ResponseCode":{"oneOf":[{"maxLength":10,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode.oneOf.0","typeLabel":"string"},{"maxLength":10,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode","typeLabel":"string | null"},"revolv3ResponseMessage":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage","typeLabel":"string | null"},"authCode":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].authCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].authCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].authCode","typeLabel":"string | null"},"processorResponseDateTime":{"maxLength":40,"type":"string","format":"date-time","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processorResponseDateTime","typeLabel":"string\u003cdate-time>"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoiceAttempts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"invoiceAttemptId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64"},"amount":{"maximum":10000000,"minimum":0,"type":"number","description":"The amount information for the payment.","format":"double"},"invoiceAttemptStatus":{"maxLength":100,"minLength":0,"type":"string","description":"The status of the invoice attempt.\r\n\r\nPossible values: `Success`, `Fail`, `Pending`, `RetrySuccess`, `RetryFail`, `RetryPending`."},"invoiceAttemptDate":{"type":"string","format":"yyyy-MM-ddTHH:mm:ss.fff"},"paymentProcessor":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the processor by which the transaction was processed.","readOnly":true},"processorTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Payment Processor Transaction Id.","readOnly":true},"responseCode":{"maxLength":10,"minLength":0,"type":"string","description":"The processor response code.","readOnly":true},"responseMessage":{"maxLength":500,"minLength":0,"type":"string","description":"The processor response message.","readOnly":true},"processorRawResponse":{"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."},"paymentMethod":{"type":"object","properties":{"paymentMethodId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier for the payment method information.","format":"int64"},"billingAddressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64"},"billingAddress":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique identifier of the address.","format":"int64"},"addressLine1":{"oneOf":[{"maxLength":40,"minLength":2,"type":"string","description":"Address."},{"maxLength":40,"minLength":2,"type":"null","description":"Address."}]},"addressLine2":{"maxLength":40,"minLength":0,"type":"string","description":"Supplemental information for the address."},"city":{"oneOf":[{"maxLength":25,"minLength":2,"type":"string","description":"City."},{"maxLength":25,"minLength":2,"type":"null","description":"City."}]},"state":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Two-letter state abbreviation."},{"maxLength":2,"minLength":2,"type":"null","description":"Two-letter state abbreviation."}]},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code."},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code."}]},"phoneNumber":{"maxLength":20,"minLength":0,"type":"string","description":"The phone number associated with a payment method that is used for billing purposes."},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email"},"country":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Country."},{"maxLength":2,"minLength":2,"type":"null","description":"Country."}]}},"additionalProperties":false},"billingFirstName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string"},{"maxLength":100,"minLength":0,"type":"null"}]},"billingLastName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string"},{"maxLength":100,"minLength":0,"type":"null"}]},"merchantPaymentMethodRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the payment method."},"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."},"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},{"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}]},"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."},"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},{"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}]}},"additionalProperties":false},"descriptor":{"type":"object","properties":{"subMerchantId":{"oneOf":[{"type":"string"},{"type":"null"}]},"subMerchantName":{"oneOf":[{"type":"string"},{"type":"null"}]},"subMerchantPhone":{"oneOf":[{"type":"string"},{"type":"null"}]},"countryCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"city":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"eligibilityCheckOrderCode":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","readOnly":true},{"maxLength":100,"minLength":0,"type":"null","readOnly":true}]},"processorMerchantId":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant account ID (MID) of the processor by which the transaction was processed."},"processingMethod":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string"},{"maxLength":50,"minLength":0,"type":"null"}]},"revolv3ResponseCode":{"oneOf":[{"maxLength":10,"minLength":0,"type":"string"},{"maxLength":10,"minLength":0,"type":"null"}]},"revolv3ResponseMessage":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string"},{"maxLength":500,"minLength":0,"type":"null"}]},"authCode":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string"},{"maxLength":20,"minLength":0,"type":"null"}]},"processorResponseDateTime":{"maxLength":40,"type":"string","format":"date-time"}},"additionalProperties":false},"uniqueKey":"invoiceAttempts.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts","typeLabel":"object[] | null"},"voidAttempts":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"voidAttemptId":{"type":"integer","format":"int64","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptId","typeLabel":"integer\u003cint64>"},"voidAttemptStatus":{"oneOf":[{"type":"string","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptStatus.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptStatus","typeLabel":"string | null"},"voidAttemptDate":{"type":"string","format":"yyyy-MM-ddTHH:mm:ss.fff","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptDate","typeLabel":"string\u003cyyyy-MM-ddTHH:mm:ss.fff>"},"paymentProcessor":{"type":"string","description":"The name of the processor by which the transaction was processed.","readOnly":true,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].paymentProcessor","typeLabel":"string"},"processorTransactionId":{"type":"string","description":"Payment Processor Transaction Id.","readOnly":true,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorTransactionId","typeLabel":"string"},"responseCode":{"type":"string","description":"The processor response code.","readOnly":true,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].responseCode","typeLabel":"string"},"responseMessage":{"type":"string","description":"The processor response message.","readOnly":true,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].responseMessage","typeLabel":"string"},"revolv3ResponseCode":{"oneOf":[{"type":"string","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode","typeLabel":"string | null"},"revolv3ResponseMessage":{"oneOf":[{"type":"string","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage","typeLabel":"string | null"},"processorResponseDateTime":{"maxLength":40,"type":"string","format":"date-time","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorResponseDateTime","typeLabel":"string\u003cdate-time>"},"processorRawResponse":{"oneOf":[{"type":"string","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorRawResponse.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorRawResponse.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorRawResponse","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voidAttempts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"voidAttemptId":{"type":"integer","format":"int64"},"voidAttemptStatus":{"oneOf":[{"type":"string"},{"type":"null"}]},"voidAttemptDate":{"type":"string","format":"yyyy-MM-ddTHH:mm:ss.fff"},"paymentProcessor":{"type":"string","description":"The name of the processor by which the transaction was processed.","readOnly":true},"processorTransactionId":{"type":"string","description":"Payment Processor Transaction Id.","readOnly":true},"responseCode":{"type":"string","description":"The processor response code.","readOnly":true},"responseMessage":{"type":"string","description":"The processor response message.","readOnly":true},"revolv3ResponseCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"revolv3ResponseMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"processorResponseDateTime":{"maxLength":40,"type":"string","format":"date-time"},"processorRawResponse":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"uniqueKey":"voidAttempts.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts","typeLabel":"object[] | null"},"invoiceStatusEnum":{"enum":["Paid","Void","Pending","Recycle","Noncollectable","Failed","Refund","MerchantPaid","MerchantCancelled","OneTimePaymentPending","PartialRefund","BatchPending","CapturePending","RefundPending","RefundDeclined","RefundFailed","RetryPending","RecurringPending","MultiCardsPending","RefundVoid","PartialRefundVoid"],"type":"string","uniqueKey":"invoiceStatusEnum","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"invoiceId":1,"parentInvoiceId":null,"customerId":null,"merchantInvoiceRefId":"1234-5678-9101","paymentMethod":{"paymentMethodId":0,"billingAddressId":0,"billingFirstName":"John","billingLastName":"Doe","merchantPaymentMethodRefId":null,"billingAddress":{"addressId":1,"addressLine1":"100 Main Street","addressLine2":null,"city":"Santa Ana","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"paymentMethodAchDetails":null,"paymentMethodCreditCardDetails":null},"invoiceStatus":"Pending","subtotal":73.1,"tax":6.48,"total":79.58,"billingDate":"10/12/2026","merchantLegalName":null,"merchantCustomerRefId":null,"customerFirstName":null,"customerLastName":null,"subscriptionId":null,"installmentId":null,"eligibilityFailReason":null,"merchantSubscriptionRefId":null,"networkTransactionId":null,"currency":null,"invoiceLineItems":[{"invoiceId":1,"invoiceLineItemId":1,"name":"LineItem1","description":"Line Item 1 Description","value":15.3,"valueType":null},{"invoiceId":1,"invoiceLineItemId":2,"name":"LineItem2","description":"Line Item 2 Description","value":25.5,"valueType":null},{"invoiceId":1,"invoiceLineItemId":3,"name":"LineItem3","description":"Line Item 3 Description","value":32.3,"valueType":null}],"invoiceAttempts":null,"voidAttempts":null},"examples":{"Example":{"title":"Example","value":{"invoiceId":1,"parentInvoiceId":null,"customerId":null,"merchantInvoiceRefId":"1234-5678-9101","paymentMethod":{"paymentMethodId":0,"billingAddressId":0,"billingFirstName":"John","billingLastName":"Doe","merchantPaymentMethodRefId":null,"billingAddress":{"addressId":1,"addressLine1":"100 Main Street","addressLine2":null,"city":"Santa Ana","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"paymentMethodAchDetails":null,"paymentMethodCreditCardDetails":null},"invoiceStatus":"Pending","subtotal":73.1,"tax":6.48,"total":79.58,"billingDate":"10/12/2026","merchantLegalName":null,"merchantCustomerRefId":null,"customerFirstName":null,"customerLastName":null,"subscriptionId":null,"installmentId":null,"eligibilityFailReason":null,"merchantSubscriptionRefId":null,"networkTransactionId":null,"currency":null,"invoiceLineItems":[{"invoiceId":1,"invoiceLineItemId":1,"name":"LineItem1","description":"Line Item 1 Description","value":15.3,"valueType":null},{"invoiceId":1,"invoiceLineItemId":2,"name":"LineItem2","description":"Line Item 2 Description","value":25.5,"valueType":null},{"invoiceId":1,"invoiceLineItemId":3,"name":"LineItem3","description":"Line Item 3 Description","value":32.3,"valueType":null}],"invoiceAttempts":null,"voidAttempts":null}}},"exampleType":"examples"},"application/json":{"schema":{"type":"object","properties":{"invoiceId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the invoice.","format":"int64","uniqueKey":"invoiceId","typeLabel":"integer\u003cint64>"},"parentInvoiceId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"parentInvoiceId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"parentInvoiceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"parentInvoiceId","typeLabel":"integer\u003cint64> | null"},"customerId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the customer.","format":"int64","uniqueKey":"customerId","typeLabel":"integer\u003cint64>"},"merchantInvoiceRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the invoice.","uniqueKey":"merchantInvoiceRefId","typeLabel":"string"},"paymentMethod":{"type":"object","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>"},"billingFirstName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s first name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingFirstName","typeLabel":"string"},"billingLastName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s last name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingLastName","typeLabel":"string"},"merchantPaymentMethodRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"paymentMethod.merchantPaymentMethodRefId","typeLabel":"string"},"billingAddress":{"type":"object","description":"The address associated with a payment method that is used for billing purposes. Either an Address ID or detailed address information can be provided.","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"},"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"},"invoiceStatus":{"maxLength":100,"minLength":0,"type":"string","description":"The current status of the invoice.\r\n\r\nPossible values: `Paid`, `Pending`, `Noncollectable`, `Failed`, `OneTimePaymentPending`, `RetryPending`.","uniqueKey":"invoiceStatus","typeLabel":"string"},"subtotal":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"subtotal","typeLabel":"number\u003cdouble>"},"tax":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"tax","typeLabel":"number\u003cdouble>"},"total":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"total","typeLabel":"number\u003cdouble>"},"billingDate":{"maxLength":20,"minLength":0,"type":"string","description":"The day on which the last billing was attempted for the invoice","uniqueKey":"billingDate","typeLabel":"string"},"merchantLegalName":{"oneOf":[{"maxLength":200,"minLength":0,"type":"string","uniqueKey":"merchantLegalName.oneOf.0","typeLabel":"string"},{"maxLength":200,"minLength":0,"type":"null","uniqueKey":"merchantLegalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantLegalName","typeLabel":"string | null"},"merchantCustomerRefId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"merchantCustomerRefId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"merchantCustomerRefId.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantCustomerRefId","typeLabel":"string | null"},"customerFirstName":{"oneOf":[{"maxLength":150,"minLength":0,"type":"string","uniqueKey":"customerFirstName.oneOf.0","typeLabel":"string"},{"maxLength":150,"minLength":0,"type":"null","uniqueKey":"customerFirstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerFirstName","typeLabel":"string | null"},"customerLastName":{"oneOf":[{"maxLength":150,"minLength":0,"type":"string","uniqueKey":"customerLastName.oneOf.0","typeLabel":"string"},{"maxLength":150,"minLength":0,"type":"null","uniqueKey":"customerLastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerLastName","typeLabel":"string | null"},"subscriptionId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"subscriptionId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"subscriptionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptionId","typeLabel":"integer\u003cint64> | null"},"installmentId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"installmentId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"installmentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"installmentId","typeLabel":"integer\u003cint64> | null"},"eligibilityFailReason":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"eligibilityFailReason.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"eligibilityFailReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"eligibilityFailReason","typeLabel":"string | null"},"merchantSubscriptionRefId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"merchantSubscriptionRefId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"merchantSubscriptionRefId.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantSubscriptionRefId","typeLabel":"string | null"},"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"},"currency":{"maxLength":3,"minLength":0,"type":"string","description":"The three-character ISO currency code.\r\n\r\nDefault value: `USD`","uniqueKey":"currency","typeLabel":"string"},"invoiceLineItems":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"invoiceLineItemId":{"maximum":1000000000,"minimum":0,"type":"integer","format":"int64","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].invoiceLineItemId","typeLabel":"integer\u003cint64>"},"name":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"description":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"value":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].value","typeLabel":"number\u003cdouble>"},"valueType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].valueType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].valueType.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].valueType","typeLabel":"string | null"},"billingValueType":{"enum":["Standard","Discount","DiscountPercentage","FinalDiscount","PriceOverride"],"type":"string","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].billingValueType","typeLabel":"enum\u003cstring>"},"invoiceId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the invoice.","format":"int64","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].invoiceId","typeLabel":"integer\u003cint64>"}},"additionalProperties":false,"uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoiceLineItems.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"invoiceLineItemId":{"maximum":1000000000,"minimum":0,"type":"integer","format":"int64"},"name":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string"},{"maxLength":100,"minLength":0,"type":"null"}]},"description":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string"},{"maxLength":500,"minLength":0,"type":"null"}]},"value":{"maximum":10000000,"minimum":0,"type":"number","format":"double"},"valueType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string"},{"maxLength":50,"minLength":0,"type":"null"}]},"billingValueType":{"enum":["Standard","Discount","DiscountPercentage","FinalDiscount","PriceOverride"],"type":"string"},"invoiceId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the invoice.","format":"int64"}},"additionalProperties":false},"uniqueKey":"invoiceLineItems.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceLineItems","typeLabel":"object[] | null"},"invoiceAttempts":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"invoiceAttemptId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].invoiceAttemptId","typeLabel":"integer\u003cint64>"},"amount":{"maximum":10000000,"minimum":0,"type":"number","description":"The amount information for the payment.","format":"double","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].amount","typeLabel":"number\u003cdouble>"},"invoiceAttemptStatus":{"maxLength":100,"minLength":0,"type":"string","description":"The status of the invoice attempt.\r\n\r\nPossible values: `Success`, `Fail`, `Pending`, `RetrySuccess`, `RetryFail`, `RetryPending`.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].invoiceAttemptStatus","typeLabel":"string"},"invoiceAttemptDate":{"type":"string","format":"yyyy-MM-ddTHH:mm:ss.fff","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].invoiceAttemptDate","typeLabel":"string\u003cyyyy-MM-ddTHH:mm:ss.fff>"},"paymentProcessor":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the processor by which the transaction was processed.","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentProcessor","typeLabel":"string"},"processorTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Payment Processor Transaction Id.","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processorTransactionId","typeLabel":"string"},"responseCode":{"maxLength":10,"minLength":0,"type":"string","description":"The processor response code.","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].responseCode","typeLabel":"string"},"responseMessage":{"maxLength":500,"minLength":0,"type":"string","description":"The processor response message.","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].responseMessage","typeLabel":"string"},"processorRawResponse":{"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":"invoiceAttempts.oneOf.0.items.[INDEX].processorRawResponse","typeLabel":"string"},"paymentMethod":{"type":"object","properties":{"paymentMethodId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier for the payment method information.","format":"int64","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodId","typeLabel":"integer\u003cint64>"},"billingAddressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddressId","typeLabel":"integer\u003cint64>"},"billingAddress":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressId","typeLabel":"integer\u003cint64>"},"addressLine1":{"oneOf":[{"maxLength":40,"minLength":2,"type":"string","description":"Address.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":40,"minLength":2,"type":"null","description":"Address.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":40,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":25,"minLength":2,"type":"string","description":"City.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":25,"minLength":2,"type":"null","description":"City.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Two-letter state abbreviation.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Two-letter state abbreviation.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.email","typeLabel":"string\u003cemail>"},"country":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Country.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Country.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress","typeLabel":"object"},"billingFirstName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingFirstName.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingFirstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingFirstName","typeLabel":"string | null"},"billingLastName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingLastName.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingLastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingLastName","typeLabel":"string | null"},"merchantPaymentMethodRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodAchDetails.oneOf.0.accountNumberLast4Digits","typeLabel":"string"},"accountNumberLength":{"maximum":17,"minimum":4,"type":"integer","description":"Bank account number length.","format":"int32","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodAchDetails.oneOf.0.accountType","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodAchDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.binNumber","typeLabel":"string"},"paymentLast4Digit":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Payment card last 4 digits.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentLast4Digit","typeLabel":"string"},"paymentExpirationDate":{"oneOf":[{"maxLength":4,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate.oneOf.0","typeLabel":"string\u003cMMYY>"},{"maxLength":4,"minLength":0,"type":"null","description":"The card expiration date.","format":"MMYY","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate","typeLabel":"string\u003cMMYY> | null"},"accountUpdateMessage":{"maxLength":500,"minLength":0,"type":"string","description":"Account updater message, if available.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateDateTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod","typeLabel":"object"},"descriptor":{"type":"object","properties":{"subMerchantId":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantId","typeLabel":"string | null"},"subMerchantName":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantName","typeLabel":"string | null"},"subMerchantPhone":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantPhone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantPhone.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantPhone","typeLabel":"string | null"},"countryCode":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.countryCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.countryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.countryCode","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.city","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor","typeLabel":"object"},"eligibilityCheckOrderCode":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].eligibilityCheckOrderCode.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].eligibilityCheckOrderCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].eligibilityCheckOrderCode","typeLabel":"string | null"},"processorMerchantId":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant account ID (MID) of the processor by which the transaction was processed.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processorMerchantId","typeLabel":"string"},"processingMethod":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processingMethod.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processingMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processingMethod","typeLabel":"string | null"},"revolv3ResponseCode":{"oneOf":[{"maxLength":10,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode.oneOf.0","typeLabel":"string"},{"maxLength":10,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode","typeLabel":"string | null"},"revolv3ResponseMessage":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage","typeLabel":"string | null"},"authCode":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].authCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].authCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].authCode","typeLabel":"string | null"},"processorResponseDateTime":{"maxLength":40,"type":"string","format":"date-time","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processorResponseDateTime","typeLabel":"string\u003cdate-time>"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoiceAttempts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"invoiceAttemptId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64"},"amount":{"maximum":10000000,"minimum":0,"type":"number","description":"The amount information for the payment.","format":"double"},"invoiceAttemptStatus":{"maxLength":100,"minLength":0,"type":"string","description":"The status of the invoice attempt.\r\n\r\nPossible values: `Success`, `Fail`, `Pending`, `RetrySuccess`, `RetryFail`, `RetryPending`."},"invoiceAttemptDate":{"type":"string","format":"yyyy-MM-ddTHH:mm:ss.fff"},"paymentProcessor":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the processor by which the transaction was processed.","readOnly":true},"processorTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Payment Processor Transaction Id.","readOnly":true},"responseCode":{"maxLength":10,"minLength":0,"type":"string","description":"The processor response code.","readOnly":true},"responseMessage":{"maxLength":500,"minLength":0,"type":"string","description":"The processor response message.","readOnly":true},"processorRawResponse":{"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."},"paymentMethod":{"type":"object","properties":{"paymentMethodId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier for the payment method information.","format":"int64"},"billingAddressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64"},"billingAddress":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique identifier of the address.","format":"int64"},"addressLine1":{"oneOf":[{"maxLength":40,"minLength":2,"type":"string","description":"Address."},{"maxLength":40,"minLength":2,"type":"null","description":"Address."}]},"addressLine2":{"maxLength":40,"minLength":0,"type":"string","description":"Supplemental information for the address."},"city":{"oneOf":[{"maxLength":25,"minLength":2,"type":"string","description":"City."},{"maxLength":25,"minLength":2,"type":"null","description":"City."}]},"state":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Two-letter state abbreviation."},{"maxLength":2,"minLength":2,"type":"null","description":"Two-letter state abbreviation."}]},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code."},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code."}]},"phoneNumber":{"maxLength":20,"minLength":0,"type":"string","description":"The phone number associated with a payment method that is used for billing purposes."},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email"},"country":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Country."},{"maxLength":2,"minLength":2,"type":"null","description":"Country."}]}},"additionalProperties":false},"billingFirstName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string"},{"maxLength":100,"minLength":0,"type":"null"}]},"billingLastName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string"},{"maxLength":100,"minLength":0,"type":"null"}]},"merchantPaymentMethodRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the payment method."},"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."},"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},{"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}]},"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."},"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},{"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}]}},"additionalProperties":false},"descriptor":{"type":"object","properties":{"subMerchantId":{"oneOf":[{"type":"string"},{"type":"null"}]},"subMerchantName":{"oneOf":[{"type":"string"},{"type":"null"}]},"subMerchantPhone":{"oneOf":[{"type":"string"},{"type":"null"}]},"countryCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"city":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"eligibilityCheckOrderCode":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","readOnly":true},{"maxLength":100,"minLength":0,"type":"null","readOnly":true}]},"processorMerchantId":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant account ID (MID) of the processor by which the transaction was processed."},"processingMethod":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string"},{"maxLength":50,"minLength":0,"type":"null"}]},"revolv3ResponseCode":{"oneOf":[{"maxLength":10,"minLength":0,"type":"string"},{"maxLength":10,"minLength":0,"type":"null"}]},"revolv3ResponseMessage":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string"},{"maxLength":500,"minLength":0,"type":"null"}]},"authCode":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string"},{"maxLength":20,"minLength":0,"type":"null"}]},"processorResponseDateTime":{"maxLength":40,"type":"string","format":"date-time"}},"additionalProperties":false},"uniqueKey":"invoiceAttempts.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts","typeLabel":"object[] | null"},"voidAttempts":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"voidAttemptId":{"type":"integer","format":"int64","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptId","typeLabel":"integer\u003cint64>"},"voidAttemptStatus":{"oneOf":[{"type":"string","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptStatus.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptStatus","typeLabel":"string | null"},"voidAttemptDate":{"type":"string","format":"yyyy-MM-ddTHH:mm:ss.fff","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptDate","typeLabel":"string\u003cyyyy-MM-ddTHH:mm:ss.fff>"},"paymentProcessor":{"type":"string","description":"The name of the processor by which the transaction was processed.","readOnly":true,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].paymentProcessor","typeLabel":"string"},"processorTransactionId":{"type":"string","description":"Payment Processor Transaction Id.","readOnly":true,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorTransactionId","typeLabel":"string"},"responseCode":{"type":"string","description":"The processor response code.","readOnly":true,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].responseCode","typeLabel":"string"},"responseMessage":{"type":"string","description":"The processor response message.","readOnly":true,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].responseMessage","typeLabel":"string"},"revolv3ResponseCode":{"oneOf":[{"type":"string","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode","typeLabel":"string | null"},"revolv3ResponseMessage":{"oneOf":[{"type":"string","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage","typeLabel":"string | null"},"processorResponseDateTime":{"maxLength":40,"type":"string","format":"date-time","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorResponseDateTime","typeLabel":"string\u003cdate-time>"},"processorRawResponse":{"oneOf":[{"type":"string","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorRawResponse.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorRawResponse.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorRawResponse","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voidAttempts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"voidAttemptId":{"type":"integer","format":"int64"},"voidAttemptStatus":{"oneOf":[{"type":"string"},{"type":"null"}]},"voidAttemptDate":{"type":"string","format":"yyyy-MM-ddTHH:mm:ss.fff"},"paymentProcessor":{"type":"string","description":"The name of the processor by which the transaction was processed.","readOnly":true},"processorTransactionId":{"type":"string","description":"Payment Processor Transaction Id.","readOnly":true},"responseCode":{"type":"string","description":"The processor response code.","readOnly":true},"responseMessage":{"type":"string","description":"The processor response message.","readOnly":true},"revolv3ResponseCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"revolv3ResponseMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"processorResponseDateTime":{"maxLength":40,"type":"string","format":"date-time"},"processorRawResponse":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"uniqueKey":"voidAttempts.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts","typeLabel":"object[] | null"},"invoiceStatusEnum":{"enum":["Paid","Void","Pending","Recycle","Noncollectable","Failed","Refund","MerchantPaid","MerchantCancelled","OneTimePaymentPending","PartialRefund","BatchPending","CapturePending","RefundPending","RefundDeclined","RefundFailed","RetryPending","RecurringPending","MultiCardsPending","RefundVoid","PartialRefundVoid"],"type":"string","uniqueKey":"invoiceStatusEnum","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"invoiceId":1,"parentInvoiceId":null,"customerId":null,"merchantInvoiceRefId":"1234-5678-9101","paymentMethod":{"paymentMethodId":0,"billingAddressId":0,"billingFirstName":"John","billingLastName":"Doe","merchantPaymentMethodRefId":null,"billingAddress":{"addressId":1,"addressLine1":"100 Main Street","addressLine2":null,"city":"Santa Ana","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"paymentMethodAchDetails":null,"paymentMethodCreditCardDetails":null},"invoiceStatus":"Pending","subtotal":73.1,"tax":6.48,"total":79.58,"billingDate":"10/12/2026","merchantLegalName":null,"merchantCustomerRefId":null,"customerFirstName":null,"customerLastName":null,"subscriptionId":null,"installmentId":null,"eligibilityFailReason":null,"merchantSubscriptionRefId":null,"networkTransactionId":null,"currency":null,"invoiceLineItems":[{"invoiceId":1,"invoiceLineItemId":1,"name":"LineItem1","description":"Line Item 1 Description","value":15.3,"valueType":null},{"invoiceId":1,"invoiceLineItemId":2,"name":"LineItem2","description":"Line Item 2 Description","value":25.5,"valueType":null},{"invoiceId":1,"invoiceLineItemId":3,"name":"LineItem3","description":"Line Item 3 Description","value":32.3,"valueType":null}],"invoiceAttempts":null,"voidAttempts":null},"examples":{"Example":{"title":"Example","value":{"invoiceId":1,"parentInvoiceId":null,"customerId":null,"merchantInvoiceRefId":"1234-5678-9101","paymentMethod":{"paymentMethodId":0,"billingAddressId":0,"billingFirstName":"John","billingLastName":"Doe","merchantPaymentMethodRefId":null,"billingAddress":{"addressId":1,"addressLine1":"100 Main Street","addressLine2":null,"city":"Santa Ana","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"paymentMethodAchDetails":null,"paymentMethodCreditCardDetails":null},"invoiceStatus":"Pending","subtotal":73.1,"tax":6.48,"total":79.58,"billingDate":"10/12/2026","merchantLegalName":null,"merchantCustomerRefId":null,"customerFirstName":null,"customerLastName":null,"subscriptionId":null,"installmentId":null,"eligibilityFailReason":null,"merchantSubscriptionRefId":null,"networkTransactionId":null,"currency":null,"invoiceLineItems":[{"invoiceId":1,"invoiceLineItemId":1,"name":"LineItem1","description":"Line Item 1 Description","value":15.3,"valueType":null},{"invoiceId":1,"invoiceLineItemId":2,"name":"LineItem2","description":"Line Item 2 Description","value":25.5,"valueType":null},{"invoiceId":1,"invoiceLineItemId":3,"name":"LineItem3","description":"Line Item 3 Description","value":32.3,"valueType":null}],"invoiceAttempts":null,"voidAttempts":null}}},"exampleType":"examples"},"text/json":{"schema":{"type":"object","properties":{"invoiceId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the invoice.","format":"int64","uniqueKey":"invoiceId","typeLabel":"integer\u003cint64>"},"parentInvoiceId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"parentInvoiceId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"parentInvoiceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"parentInvoiceId","typeLabel":"integer\u003cint64> | null"},"customerId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the customer.","format":"int64","uniqueKey":"customerId","typeLabel":"integer\u003cint64>"},"merchantInvoiceRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the invoice.","uniqueKey":"merchantInvoiceRefId","typeLabel":"string"},"paymentMethod":{"type":"object","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>"},"billingFirstName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s first name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingFirstName","typeLabel":"string"},"billingLastName":{"maxLength":100,"minLength":0,"type":"string","description":"**Conditional**: either both BillingFirstName and BillingLastName or BillingFullName must be provided.\r\n\r\nThe customer’s last name associated with a payment method that is used for billing purposes.","uniqueKey":"paymentMethod.billingLastName","typeLabel":"string"},"merchantPaymentMethodRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"paymentMethod.merchantPaymentMethodRefId","typeLabel":"string"},"billingAddress":{"type":"object","description":"The address associated with a payment method that is used for billing purposes. Either an Address ID or detailed address information can be provided.","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"},"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"},"invoiceStatus":{"maxLength":100,"minLength":0,"type":"string","description":"The current status of the invoice.\r\n\r\nPossible values: `Paid`, `Pending`, `Noncollectable`, `Failed`, `OneTimePaymentPending`, `RetryPending`.","uniqueKey":"invoiceStatus","typeLabel":"string"},"subtotal":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"subtotal","typeLabel":"number\u003cdouble>"},"tax":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"tax","typeLabel":"number\u003cdouble>"},"total":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"total","typeLabel":"number\u003cdouble>"},"billingDate":{"maxLength":20,"minLength":0,"type":"string","description":"The day on which the last billing was attempted for the invoice","uniqueKey":"billingDate","typeLabel":"string"},"merchantLegalName":{"oneOf":[{"maxLength":200,"minLength":0,"type":"string","uniqueKey":"merchantLegalName.oneOf.0","typeLabel":"string"},{"maxLength":200,"minLength":0,"type":"null","uniqueKey":"merchantLegalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantLegalName","typeLabel":"string | null"},"merchantCustomerRefId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"merchantCustomerRefId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"merchantCustomerRefId.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantCustomerRefId","typeLabel":"string | null"},"customerFirstName":{"oneOf":[{"maxLength":150,"minLength":0,"type":"string","uniqueKey":"customerFirstName.oneOf.0","typeLabel":"string"},{"maxLength":150,"minLength":0,"type":"null","uniqueKey":"customerFirstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerFirstName","typeLabel":"string | null"},"customerLastName":{"oneOf":[{"maxLength":150,"minLength":0,"type":"string","uniqueKey":"customerLastName.oneOf.0","typeLabel":"string"},{"maxLength":150,"minLength":0,"type":"null","uniqueKey":"customerLastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerLastName","typeLabel":"string | null"},"subscriptionId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"subscriptionId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"subscriptionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptionId","typeLabel":"integer\u003cint64> | null"},"installmentId":{"oneOf":[{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"installmentId.oneOf.0","typeLabel":"integer\u003cint64>"},{"maximum":1000000000,"minimum":1,"type":"null","format":"int64","uniqueKey":"installmentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"installmentId","typeLabel":"integer\u003cint64> | null"},"eligibilityFailReason":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"eligibilityFailReason.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"eligibilityFailReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"eligibilityFailReason","typeLabel":"string | null"},"merchantSubscriptionRefId":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"merchantSubscriptionRefId.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"merchantSubscriptionRefId.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchantSubscriptionRefId","typeLabel":"string | null"},"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"},"currency":{"maxLength":3,"minLength":0,"type":"string","description":"The three-character ISO currency code.\r\n\r\nDefault value: `USD`","uniqueKey":"currency","typeLabel":"string"},"invoiceLineItems":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"invoiceLineItemId":{"maximum":1000000000,"minimum":0,"type":"integer","format":"int64","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].invoiceLineItemId","typeLabel":"integer\u003cint64>"},"name":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"description":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"value":{"maximum":10000000,"minimum":0,"type":"number","format":"double","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].value","typeLabel":"number\u003cdouble>"},"valueType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].valueType.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].valueType.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].valueType","typeLabel":"string | null"},"billingValueType":{"enum":["Standard","Discount","DiscountPercentage","FinalDiscount","PriceOverride"],"type":"string","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].billingValueType","typeLabel":"enum\u003cstring>"},"invoiceId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the invoice.","format":"int64","uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX].invoiceId","typeLabel":"integer\u003cint64>"}},"additionalProperties":false,"uniqueKey":"invoiceLineItems.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoiceLineItems.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"invoiceLineItemId":{"maximum":1000000000,"minimum":0,"type":"integer","format":"int64"},"name":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string"},{"maxLength":100,"minLength":0,"type":"null"}]},"description":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string"},{"maxLength":500,"minLength":0,"type":"null"}]},"value":{"maximum":10000000,"minimum":0,"type":"number","format":"double"},"valueType":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string"},{"maxLength":50,"minLength":0,"type":"null"}]},"billingValueType":{"enum":["Standard","Discount","DiscountPercentage","FinalDiscount","PriceOverride"],"type":"string"},"invoiceId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the invoice.","format":"int64"}},"additionalProperties":false},"uniqueKey":"invoiceLineItems.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceLineItems","typeLabel":"object[] | null"},"invoiceAttempts":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"invoiceAttemptId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].invoiceAttemptId","typeLabel":"integer\u003cint64>"},"amount":{"maximum":10000000,"minimum":0,"type":"number","description":"The amount information for the payment.","format":"double","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].amount","typeLabel":"number\u003cdouble>"},"invoiceAttemptStatus":{"maxLength":100,"minLength":0,"type":"string","description":"The status of the invoice attempt.\r\n\r\nPossible values: `Success`, `Fail`, `Pending`, `RetrySuccess`, `RetryFail`, `RetryPending`.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].invoiceAttemptStatus","typeLabel":"string"},"invoiceAttemptDate":{"type":"string","format":"yyyy-MM-ddTHH:mm:ss.fff","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].invoiceAttemptDate","typeLabel":"string\u003cyyyy-MM-ddTHH:mm:ss.fff>"},"paymentProcessor":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the processor by which the transaction was processed.","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentProcessor","typeLabel":"string"},"processorTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Payment Processor Transaction Id.","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processorTransactionId","typeLabel":"string"},"responseCode":{"maxLength":10,"minLength":0,"type":"string","description":"The processor response code.","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].responseCode","typeLabel":"string"},"responseMessage":{"maxLength":500,"minLength":0,"type":"string","description":"The processor response message.","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].responseMessage","typeLabel":"string"},"processorRawResponse":{"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":"invoiceAttempts.oneOf.0.items.[INDEX].processorRawResponse","typeLabel":"string"},"paymentMethod":{"type":"object","properties":{"paymentMethodId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier for the payment method information.","format":"int64","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodId","typeLabel":"integer\u003cint64>"},"billingAddressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddressId","typeLabel":"integer\u003cint64>"},"billingAddress":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique identifier of the address.","format":"int64","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressId","typeLabel":"integer\u003cint64>"},"addressLine1":{"oneOf":[{"maxLength":40,"minLength":2,"type":"string","description":"Address.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressLine1.oneOf.0","typeLabel":"string"},{"maxLength":40,"minLength":2,"type":"null","description":"Address.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressLine1","typeLabel":"string | null"},"addressLine2":{"maxLength":40,"minLength":0,"type":"string","description":"Supplemental information for the address.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.addressLine2","typeLabel":"string"},"city":{"oneOf":[{"maxLength":25,"minLength":2,"type":"string","description":"City.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.city.oneOf.0","typeLabel":"string"},{"maxLength":25,"minLength":2,"type":"null","description":"City.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.city","typeLabel":"string | null"},"state":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Two-letter state abbreviation.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.state.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Two-letter state abbreviation.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.phoneNumber","typeLabel":"string"},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.email","typeLabel":"string\u003cemail>"},"country":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Country.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.country.oneOf.0","typeLabel":"string"},{"maxLength":2,"minLength":2,"type":"null","description":"Country.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingAddress","typeLabel":"object"},"billingFirstName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingFirstName.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingFirstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingFirstName","typeLabel":"string | null"},"billingLastName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingLastName.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingLastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.billingLastName","typeLabel":"string | null"},"merchantPaymentMethodRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the payment method.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodAchDetails.oneOf.0.accountNumberLast4Digits","typeLabel":"string"},"accountNumberLength":{"maximum":17,"minimum":4,"type":"integer","description":"Bank account number length.","format":"int32","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodAchDetails.oneOf.0.accountType","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodAchDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.binNumber","typeLabel":"string"},"paymentLast4Digit":{"maxLength":4,"minLength":4,"pattern":"^\\d{4}$","type":"string","description":"Payment card last 4 digits.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentLast4Digit","typeLabel":"string"},"paymentExpirationDate":{"oneOf":[{"maxLength":4,"minLength":0,"type":"string","description":"The card expiration date.","format":"MMYY","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate.oneOf.0","typeLabel":"string\u003cMMYY>"},{"maxLength":4,"minLength":0,"type":"null","description":"The card expiration date.","format":"MMYY","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentExpirationDate","typeLabel":"string\u003cMMYY> | null"},"accountUpdateMessage":{"maxLength":500,"minLength":0,"type":"string","description":"Account updater message, if available.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.accountUpdateDateTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.0.paymentAccountNumber","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].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":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod.paymentMethodCreditCardDetails","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].paymentMethod","typeLabel":"object"},"descriptor":{"type":"object","properties":{"subMerchantId":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantId","typeLabel":"string | null"},"subMerchantName":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantName.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantName","typeLabel":"string | null"},"subMerchantPhone":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantPhone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantPhone.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.subMerchantPhone","typeLabel":"string | null"},"countryCode":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.countryCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.countryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.countryCode","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor.city","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].descriptor","typeLabel":"object"},"eligibilityCheckOrderCode":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].eligibilityCheckOrderCode.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","readOnly":true,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].eligibilityCheckOrderCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].eligibilityCheckOrderCode","typeLabel":"string | null"},"processorMerchantId":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant account ID (MID) of the processor by which the transaction was processed.","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processorMerchantId","typeLabel":"string"},"processingMethod":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processingMethod.oneOf.0","typeLabel":"string"},{"maxLength":50,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processingMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processingMethod","typeLabel":"string | null"},"revolv3ResponseCode":{"oneOf":[{"maxLength":10,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode.oneOf.0","typeLabel":"string"},{"maxLength":10,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode","typeLabel":"string | null"},"revolv3ResponseMessage":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage.oneOf.0","typeLabel":"string"},{"maxLength":500,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage","typeLabel":"string | null"},"authCode":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].authCode.oneOf.0","typeLabel":"string"},{"maxLength":20,"minLength":0,"type":"null","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].authCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].authCode","typeLabel":"string | null"},"processorResponseDateTime":{"maxLength":40,"type":"string","format":"date-time","uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX].processorResponseDateTime","typeLabel":"string\u003cdate-time>"}},"additionalProperties":false,"uniqueKey":"invoiceAttempts.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"invoiceAttempts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"invoiceAttemptId":{"maximum":1000000000,"minimum":1,"type":"integer","format":"int64"},"amount":{"maximum":10000000,"minimum":0,"type":"number","description":"The amount information for the payment.","format":"double"},"invoiceAttemptStatus":{"maxLength":100,"minLength":0,"type":"string","description":"The status of the invoice attempt.\r\n\r\nPossible values: `Success`, `Fail`, `Pending`, `RetrySuccess`, `RetryFail`, `RetryPending`."},"invoiceAttemptDate":{"type":"string","format":"yyyy-MM-ddTHH:mm:ss.fff"},"paymentProcessor":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the processor by which the transaction was processed.","readOnly":true},"processorTransactionId":{"maxLength":100,"minLength":0,"type":"string","description":"Payment Processor Transaction Id.","readOnly":true},"responseCode":{"maxLength":10,"minLength":0,"type":"string","description":"The processor response code.","readOnly":true},"responseMessage":{"maxLength":500,"minLength":0,"type":"string","description":"The processor response message.","readOnly":true},"processorRawResponse":{"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."},"paymentMethod":{"type":"object","properties":{"paymentMethodId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier for the payment method information.","format":"int64"},"billingAddressId":{"maximum":1000000000,"minimum":1,"type":"integer","description":"The unique identifier of the address.","format":"int64"},"billingAddress":{"type":"object","properties":{"addressId":{"type":"integer","description":"The unique identifier of the address.","format":"int64"},"addressLine1":{"oneOf":[{"maxLength":40,"minLength":2,"type":"string","description":"Address."},{"maxLength":40,"minLength":2,"type":"null","description":"Address."}]},"addressLine2":{"maxLength":40,"minLength":0,"type":"string","description":"Supplemental information for the address."},"city":{"oneOf":[{"maxLength":25,"minLength":2,"type":"string","description":"City."},{"maxLength":25,"minLength":2,"type":"null","description":"City."}]},"state":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Two-letter state abbreviation."},{"maxLength":2,"minLength":2,"type":"null","description":"Two-letter state abbreviation."}]},"postalCode":{"oneOf":[{"maxLength":20,"minLength":2,"type":"string","description":"Postal Code."},{"maxLength":20,"minLength":2,"type":"null","description":"Postal Code."}]},"phoneNumber":{"maxLength":20,"minLength":0,"type":"string","description":"The phone number associated with a payment method that is used for billing purposes."},"email":{"maxLength":100,"minLength":0,"type":"string","description":"The email associated with a billing address.","format":"email"},"country":{"oneOf":[{"maxLength":2,"minLength":2,"type":"string","description":"Country."},{"maxLength":2,"minLength":2,"type":"null","description":"Country."}]}},"additionalProperties":false},"billingFirstName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string"},{"maxLength":100,"minLength":0,"type":"null"}]},"billingLastName":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string"},{"maxLength":100,"minLength":0,"type":"null"}]},"merchantPaymentMethodRefId":{"maxLength":100,"minLength":0,"type":"string","description":"Merchant's unique identifier for the payment method."},"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."},"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},{"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}]},"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."},"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},{"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}]}},"additionalProperties":false},"descriptor":{"type":"object","properties":{"subMerchantId":{"oneOf":[{"type":"string"},{"type":"null"}]},"subMerchantName":{"oneOf":[{"type":"string"},{"type":"null"}]},"subMerchantPhone":{"oneOf":[{"type":"string"},{"type":"null"}]},"countryCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"city":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"eligibilityCheckOrderCode":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","readOnly":true},{"maxLength":100,"minLength":0,"type":"null","readOnly":true}]},"processorMerchantId":{"maxLength":100,"minLength":0,"type":"string","description":"The merchant account ID (MID) of the processor by which the transaction was processed."},"processingMethod":{"oneOf":[{"maxLength":50,"minLength":0,"type":"string"},{"maxLength":50,"minLength":0,"type":"null"}]},"revolv3ResponseCode":{"oneOf":[{"maxLength":10,"minLength":0,"type":"string"},{"maxLength":10,"minLength":0,"type":"null"}]},"revolv3ResponseMessage":{"oneOf":[{"maxLength":500,"minLength":0,"type":"string"},{"maxLength":500,"minLength":0,"type":"null"}]},"authCode":{"oneOf":[{"maxLength":20,"minLength":0,"type":"string"},{"maxLength":20,"minLength":0,"type":"null"}]},"processorResponseDateTime":{"maxLength":40,"type":"string","format":"date-time"}},"additionalProperties":false},"uniqueKey":"invoiceAttempts.oneOf.1","typeLabel":"null"}],"uniqueKey":"invoiceAttempts","typeLabel":"object[] | null"},"voidAttempts":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"voidAttemptId":{"type":"integer","format":"int64","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptId","typeLabel":"integer\u003cint64>"},"voidAttemptStatus":{"oneOf":[{"type":"string","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptStatus.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptStatus","typeLabel":"string | null"},"voidAttemptDate":{"type":"string","format":"yyyy-MM-ddTHH:mm:ss.fff","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].voidAttemptDate","typeLabel":"string\u003cyyyy-MM-ddTHH:mm:ss.fff>"},"paymentProcessor":{"type":"string","description":"The name of the processor by which the transaction was processed.","readOnly":true,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].paymentProcessor","typeLabel":"string"},"processorTransactionId":{"type":"string","description":"Payment Processor Transaction Id.","readOnly":true,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorTransactionId","typeLabel":"string"},"responseCode":{"type":"string","description":"The processor response code.","readOnly":true,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].responseCode","typeLabel":"string"},"responseMessage":{"type":"string","description":"The processor response message.","readOnly":true,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].responseMessage","typeLabel":"string"},"revolv3ResponseCode":{"oneOf":[{"type":"string","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseCode","typeLabel":"string | null"},"revolv3ResponseMessage":{"oneOf":[{"type":"string","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].revolv3ResponseMessage","typeLabel":"string | null"},"processorResponseDateTime":{"maxLength":40,"type":"string","format":"date-time","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorResponseDateTime","typeLabel":"string\u003cdate-time>"},"processorRawResponse":{"oneOf":[{"type":"string","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorRawResponse.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorRawResponse.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX].processorRawResponse","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"voidAttempts.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"voidAttempts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"voidAttemptId":{"type":"integer","format":"int64"},"voidAttemptStatus":{"oneOf":[{"type":"string"},{"type":"null"}]},"voidAttemptDate":{"type":"string","format":"yyyy-MM-ddTHH:mm:ss.fff"},"paymentProcessor":{"type":"string","description":"The name of the processor by which the transaction was processed.","readOnly":true},"processorTransactionId":{"type":"string","description":"Payment Processor Transaction Id.","readOnly":true},"responseCode":{"type":"string","description":"The processor response code.","readOnly":true},"responseMessage":{"type":"string","description":"The processor response message.","readOnly":true},"revolv3ResponseCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"revolv3ResponseMessage":{"oneOf":[{"type":"string"},{"type":"null"}]},"processorResponseDateTime":{"maxLength":40,"type":"string","format":"date-time"},"processorRawResponse":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},"uniqueKey":"voidAttempts.oneOf.1","typeLabel":"null"}],"uniqueKey":"voidAttempts","typeLabel":"object[] | null"},"invoiceStatusEnum":{"enum":["Paid","Void","Pending","Recycle","Noncollectable","Failed","Refund","MerchantPaid","MerchantCancelled","OneTimePaymentPending","PartialRefund","BatchPending","CapturePending","RefundPending","RefundDeclined","RefundFailed","RetryPending","RecurringPending","MultiCardsPending","RefundVoid","PartialRefundVoid"],"type":"string","uniqueKey":"invoiceStatusEnum","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"invoiceId":1,"parentInvoiceId":null,"customerId":null,"merchantInvoiceRefId":"1234-5678-9101","paymentMethod":{"paymentMethodId":0,"billingAddressId":0,"billingFirstName":"John","billingLastName":"Doe","merchantPaymentMethodRefId":null,"billingAddress":{"addressId":1,"addressLine1":"100 Main Street","addressLine2":null,"city":"Santa Ana","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"paymentMethodAchDetails":null,"paymentMethodCreditCardDetails":null},"invoiceStatus":"Pending","subtotal":73.1,"tax":6.48,"total":79.58,"billingDate":"10/12/2026","merchantLegalName":null,"merchantCustomerRefId":null,"customerFirstName":null,"customerLastName":null,"subscriptionId":null,"installmentId":null,"eligibilityFailReason":null,"merchantSubscriptionRefId":null,"networkTransactionId":null,"currency":null,"invoiceLineItems":[{"invoiceId":1,"invoiceLineItemId":1,"name":"LineItem1","description":"Line Item 1 Description","value":15.3,"valueType":null},{"invoiceId":1,"invoiceLineItemId":2,"name":"LineItem2","description":"Line Item 2 Description","value":25.5,"valueType":null},{"invoiceId":1,"invoiceLineItemId":3,"name":"LineItem3","description":"Line Item 3 Description","value":32.3,"valueType":null}],"invoiceAttempts":null,"voidAttempts":null},"examples":{"Example":{"title":"Example","value":{"invoiceId":1,"parentInvoiceId":null,"customerId":null,"merchantInvoiceRefId":"1234-5678-9101","paymentMethod":{"paymentMethodId":0,"billingAddressId":0,"billingFirstName":"John","billingLastName":"Doe","merchantPaymentMethodRefId":null,"billingAddress":{"addressId":1,"addressLine1":"100 Main Street","addressLine2":null,"city":"Santa Ana","state":"CA","postalCode":"92602","phoneNumber":null,"email":null,"country":"US"},"paymentMethodAchDetails":null,"paymentMethodCreditCardDetails":null},"invoiceStatus":"Pending","subtotal":73.1,"tax":6.48,"total":79.58,"billingDate":"10/12/2026","merchantLegalName":null,"merchantCustomerRefId":null,"customerFirstName":null,"customerLastName":null,"subscriptionId":null,"installmentId":null,"eligibilityFailReason":null,"merchantSubscriptionRefId":null,"networkTransactionId":null,"currency":null,"invoiceLineItems":[{"invoiceId":1,"invoiceLineItemId":1,"name":"LineItem1","description":"Line Item 1 Description","value":15.3,"valueType":null},{"invoiceId":1,"invoiceLineItemId":2,"name":"LineItem2","description":"Line Item 2 Description","value":25.5,"valueType":null},{"invoiceId":1,"invoiceLineItemId":3,"name":"LineItem3","description":"Line Item 3 Description","value":32.3,"valueType":null}],"invoiceAttempts":null,"voidAttempts":null}}},"exampleType":"examples"}},"exampleType":"examples"},"a2c43993-eb04-4525-8d57-01b8353b8b96":{"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"},"12436dea-a4ff-4c5f-8cc4-7a5129121c2e":{"description":"Not Found","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 find an entity with the provided data."},"examples":{"Example":{"title":"Example","value":{"message":"Unable to find an entity with the provided data."}}},"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 find an entity with the provided data."},"examples":{"Example":{"title":"Example","value":{"message":"Unable to find an entity with the provided data."}}},"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 find an entity with the provided data."},"examples":{"Example":{"title":"Example","value":{"message":"Unable to find an entity with the provided data."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e41f5236-e293-4e70-a1c9-570b882f4334":{"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":"Get Invoice - Introduction \u0026 Quick Start","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-13T22:34:17.822Z","originalFileLocation":"api-reference/invoices/get-invoice.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=\"Retrieves detailed information about a specific invoice using its unique invoice ID. This endpoint returns invoice metadata, payment status, amount, associated payment method references, and timestamps related to invoice attempts. It’s ideal when you already know the invoice ID and need to fetch its full details for display, audit, or troubleshooting purposes. Supports use cases like viewing a transaction in the portal or validating an invoice after a payment operation. Optionally, you can set includeRawProcessorResponse = true to include the raw response returned from the payment processor, which can help with advanced debugging or support cases.\">\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=\"Get Invoice - Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves detailed information about a specific invoice using its unique invoice ID. This endpoint returns invoice metadata, payment status, amount, associated payment method references, and timestamps related to invoice attempts. It’s ideal when you already know the invoice ID and need to fetch its full details for display, audit, or troubleshooting purposes. Supports use cases like viewing a transaction in the portal or validating an invoice after a payment operation. Optionally, you can set includeRawProcessorResponse = true to include the raw response returned from the payment processor, which can help with advanced debugging or support cases.\">\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/invoices/get-invoice\">\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=Invoices\u0026amp;title=Get+Invoice\u0026amp;description=Retrieves+detailed+information+about+a+**specific+invoice**+using+its+unique+invoice+ID.%0D%0AThis+endpoint+returns+invoice+metadata%2C+payment+status%2C+amount%2C+associ\u0026amp;theme=44ecc26a32f1a478fe3476c2\u0026amp;signature=b8e17ca0338e1c5d5a7b1dabde7a85f39f575ae67fb76d8e4a795f28608e227d\">\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=\"Get Invoice - Introduction \u0026amp; Quick Start\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves detailed information about a specific invoice using its unique invoice ID. This endpoint returns invoice metadata, payment status, amount, associated payment method references, and timestamps related to invoice attempts. It’s ideal when you already know the invoice ID and need to fetch its full details for display, audit, or troubleshooting purposes. Supports use cases like viewing a transaction in the portal or validating an invoice after a payment operation. Optionally, you can set includeRawProcessorResponse = true to include the raw response returned from the payment processor, which can help with advanced debugging or support cases.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://revolv3.mintlify.app/_mintlify/api/og/v2?division=Invoices\u0026amp;title=Get+Invoice\u0026amp;description=Retrieves+detailed+information+about+a+**specific+invoice**+using+its+unique+invoice+ID.%0D%0AThis+endpoint+returns+invoice+metadata%2C+payment+status%2C+amount%2C+associ\u0026amp;theme=44ecc26a32f1a478fe3476c2\u0026amp;signature=b8e17ca0338e1c5d5a7b1dabde7a85f39f575ae67fb76d8e4a795f28608e227d\">\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/invoices/get-invoice\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/invoices/get-invoice.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/invoices/get-invoice#webpage\",\"url\":\"https://docs.revolv3.com/api-reference/invoices/get-invoice\",\"name\":\"Get Invoice\",\"description\":\"Retrieves detailed information about a specific invoice using its unique invoice ID. This endpoint returns invoice metadata, payment status, amount, associated payment method references, and timestamps related to invoice attempts. It’s ideal when you already know the invoice ID and need to fetch its full details for display, audit, or troubleshooting purposes. Supports use cases like viewing a transaction in the portal or validating an invoice after a payment operation. Optionally, you can set includeRawProcessorResponse = true to include the raw response returned from the payment processor, which can help with advanced debugging or support cases.\",\"dateModified\":\"2026-10-13T22:34:17.822Z\",\"isPartOf\":{\"@id\":\"https://docs.revolv3.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.revolv3.com/api-reference/invoices/get-invoice#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.revolv3.com/api-reference/invoices/get-invoice#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Invoices\",\"item\":\"https://docs.revolv3.com/api-reference/invoices/get-invoices\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Invoice\",\"item\":\"https://docs.revolv3.com/api-reference/invoices/get-invoice\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.revolv3.com/api-reference/invoices/get-invoice#apireference\",\"headline\":\"Get Invoice\",\"name\":\"Get Invoice\",\"description\":\"Retrieves detailed information about a specific invoice using its unique invoice ID. This endpoint returns invoice metadata, payment status, amount, associated payment method references, and timestamps related to invoice attempts. It’s ideal when you already know the invoice ID and need to fetch its full details for display, audit, or troubleshooting purposes. Supports use cases like viewing a transaction in the portal or validating an invoice after a payment operation. Optionally, you can set includeRawProcessorResponse = true to include the raw response returned from the payment processor, which can help with advanced debugging or support cases.\",\"url\":\"https://docs.revolv3.com/api-reference/invoices/get-invoice\",\"mainEntityOfPage\":{\"@id\":\"https://docs.revolv3.com/api-reference/invoices/get-invoice#webpage\"},\"dateModified\":\"2026-10-13T22:34:17.822Z\",\"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","description":"Returns a **detailed list of invoices** using the latest version of our invoice retrieval logic.\r\nThis endpoint provides comprehensive invoice information, including status, payment attempts, raw processor responses (if enabled), and additional filtering options available beyond the legacy version.\r\n\r\nIt supports flexible search by merchant customer reference, billing timestamps, and update timestamps.\r\nPagination is supported via **Page** and **PageSize** query parameters — with a maximum of **100 entries per page**. If not specified, the default is **page 1** with **100 results**.\r\n\r\nUse this endpoint to power dashboards, reporting tools, or reconciliation processes requiring complete invoice details.\r\nThis is the **recommended endpoint** for retrieving invoices moving forward.","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","description":"Initiates a **refund** for a previously paid invoice.\r\nThis endpoint allows full or partial refunds, depending on the amount specified in the request.\r\n\r\nYou must supply the unique `invoiceId` of the transaction to be refunded, along with the refund amount (for partial refund).\r\nThe system validates the refund against the original payment details and ensures it does not exceed the total invoice value.\r\nUseful for customer-initiated cancellations, returns, or support-driven refund requests.\r\nAll refund attempts are tracked and reflected in the invoice history and reporting.","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","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","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":"Get Invoice - 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"]}