{"items":[{"type":"link","label":"Flute - API Reference Guide","link":"/api-reference/v2","routeSlug":"/api-reference/v2","content":{"contentType":"overview","meta":{"name":"Flute - API Reference Guide"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/api-reference/@v2/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/api-reference/@v2/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Flute - API Reference Guide (V2 Beta)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Build date: 8.13.2026 10:19 AM"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"color":"#d32f2f","borderLeft":"4px solid #d32f2f","paddingLeft":"1rem"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"strong","attrs":{"style":{"fontSize":"1.5em"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"⚠️ Beta Release"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The v2 API is currently in active development."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Functionality, request and response formats, field names, and behavior may change before the stable release."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review the release notes regularly for updates."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:developer@flute.com?subject=About%20Flute%20API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Developer Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for further details."},"children":[]}]}]}]}]}],"sectionId":"/api-reference/v2"}],"sectionId":"/api-reference/v2"}]}]}},{"type":"separator","label":"Flute API Overview","content":null},{"type":"group","label":"Getting Started","link":"/api-reference/v2/getting-started","routeSlug":"/api-reference/v2/getting-started","items":[{"type":"link","label":"Creating a Flute Account","link":"/api-reference/v2/getting-started/creating-a-flute-account","routeSlug":"/api-reference/v2/getting-started/creating-a-flute-account","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Creating a Flute Account"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"getting-started/creating-a-flute-account"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating a Flute Account"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h1","attrs":{"style":{"marginTop":"-12px","marginBottom":"4px"}}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before using Flute payment capabilities or the Flute API suite, you must create a Flute sandbox account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All development and testing occurs first in a sandbox account."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sandbox account is a fully isolated account that mirrors production behavior."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All transactions, sales, and Flute API endpoints may be made in the sandbox."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, it does not process real transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is used to validate your integration, applications, and workflows before going live."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The account is free, does not require approval, and is self managed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the following procedure to create the Flute sandbox account and a merchant API key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant API key is required to generate an API token, used to make each call."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/docs/getting-started/api-authentication#creating-a-flute-sandbox-account","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating a Flute Account"},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Developing in the Sandbox Environment","link":"/api-reference/v2/getting-started/developing-in-the-sandbox-environment","routeSlug":"/api-reference/v2/getting-started/developing-in-the-sandbox-environment","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Developing in the Sandbox Environment"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"getting-started/developing-in-the-sandbox-environment"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Developing in the Sandbox Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sandbox account is a fully isolated account that mirrors production behavior."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It does not process real transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the sandbox for all testing and app development."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Flute support team is available with assistance for developing workflows and tools."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Even after going live, it may still be used to develop and test apps."},"children":[]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Going Live","link":"/api-reference/v2/getting-started/going-live","routeSlug":"/api-reference/v2/getting-started/going-live","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Going Live"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"getting-started/going-live"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Going Live"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When your product is ready to be deployed live, the Flute support team will work with you to ensure compliance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This compliance follows the production readiness checklist."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It ensures the best and optimal developer, client, and customer experience."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information and details about the production readiness checklist, "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/docs/launch/go-live","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production Go-Live Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"Getting Started"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting Started","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is an overview for using the Flute API suite and making endpoint calls."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting started has the following steps:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating a Flute Account"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Developing in the Sandbox Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Going Live"},"children":[]}]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/getting-started"}],"panels":[]}]}},{"type":"group","label":"API Suite Fundamentals","link":"/api-reference/v2/api-suite-fundamentals","routeSlug":"/api-reference/v2/api-suite-fundamentals","items":[{"type":"link","label":"baseURL Environments","link":"/api-reference/v2/api-suite-fundamentals/baseurl-environments","routeSlug":"/api-reference/v2/api-suite-fundamentals/baseurl-environments","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"baseURL Environments"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"api-suite-fundamentals/baseurl-environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL Environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flute provides different environments to run endpoints."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"urlbases"}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sandbox environment is for development and testing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No payments, charges, or invoices will be enforced."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is a fully isolated account that mirrors production behavior."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is used to validate your integration before going live."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You will work with your Flute support team developing workflows and tools."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://sandbox.api.flute.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The production environment is for deploying the payment system live to clients."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All payments, charges, or invoices are live and will be enforced."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When your product is ready to be deployed live, the Flute support team will work with you to ensure compliance."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This compliance follows the production readiness checklist."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It ensures the best and optimal developer, client, and customer experience."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information and details about the production readiness checklist, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/docs/launch/go-live","target":"_blank","rel":"noopener noreferrer"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production Go-Live Guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.flute.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using the baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the baseURL instead of the placeholder noted in each endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, an endpoint may be described in the endpoint documentation as:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET {{baseURL}}/v2/customers"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To make this call in the sandbox environment, use:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST https://sandbox.api.flute.com/v2/customers"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To make this call in the production environment, use:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST https://api.flute.com/v2/customers"},"children":[]}]}]}]}],"panels":[]}]}},{"type":"group","label":"Payment Flow","link":"/api-reference/v2/api-suite-fundamentals/payment-flow","routeSlug":"/api-reference/v2/api-suite-fundamentals/payment-flow","items":[{"type":"link","label":"Approving a Purchase Request","link":"/api-reference/v2/api-suite-fundamentals/payment-flow/approving-a-purchase-request","routeSlug":"/api-reference/v2/api-suite-fundamentals/payment-flow/approving-a-purchase-request","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Approving a Purchase Request"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"api-suite-fundamentals/payment-flow/approving-a-purchase-request"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approving a Purchase Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer completes their shopping experience on the merchant's website by selecting the products or services."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They navigate to the checkout page on the merchant's website."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They enter their personal and payment information. This could include card details, or net banking information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's website captures these details, formatting the details as needed to conform to Flute payment gateway requirements."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This sensitive data is transmitted by a secure connection (HTTPS) to the Flute payment gateway."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Flute payment gateway is a service that makes authorization and sale by cards or ACH (automated clearing house, an electronic network used by financial institutions to process direct deposits)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upon receiving this information, the Flute payment gateway further routes this payment data to the processing center, such as TSYS."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This entity communicates with the customer's bank to get authorization or denial for the payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The processing center determines if the payment is approved, that is, if there are sufficient funds or credit available in the customer's account."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Acknowledging a Purchase Request","link":"/api-reference/v2/api-suite-fundamentals/payment-flow/acknowledging-a-purchase-request","routeSlug":"/api-reference/v2/api-suite-fundamentals/payment-flow/acknowledging-a-purchase-request","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Acknowledging a Purchase Request"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"api-suite-fundamentals/payment-flow/acknowledging-a-purchase-request"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acknowledging a Purchase Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the transaction is processed, the processing center sends back a response to the Flute payment gateway."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This response includes details of the transaction, such as whether it was approved or declined."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Flute payment gateway relays this information back to the merchant's website."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's website receives this information and displays a message or signal for the customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on whether the transaction was approved or declined, the appropriate message is displayed to the customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For instance:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If transaction was successful, a confirmation message is shown, usually with a transaction ID and other details."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If it was declined, the customer is informed and typically asked to try another payment method."},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Supported Card Types","link":"/api-reference/v2/api-suite-fundamentals/payment-flow/supported-card-types","routeSlug":"/api-reference/v2/api-suite-fundamentals/payment-flow/supported-card-types","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Supported Card Types"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"api-suite-fundamentals/payment-flow/supported-card-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Card Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h1","attrs":{"style":{"marginTop":"-12px","marginBottom":"4px"}}},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n  The following credit cards and formats are supported.\n"},"children":[]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Diners Club: Card numbers are typically 14 or 16 digits long."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover: Card numbers are typically 16 digits long."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JCB: Card numbers are typically 16 digits long."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MasterCard: Card numbers are typically 16 digits long."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VISA: Card numbers are typically 13 or 16 digits long."},"children":[]}]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Payment Flow"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"api-suite-fundamentals/payment-flow"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Flow"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h1","attrs":{"style":{"marginTop":"-12px","marginBottom":"4px"}}},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n  The following is a generalized workflow.\n"},"children":[]}]}],"panels":[]}]}},{"type":"link","label":"Flute-Defined Enums","link":"/api-reference/v2/api-suite-fundamentals/flute-defined-enums","routeSlug":"/api-reference/v2/api-suite-fundamentals/flute-defined-enums","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Flute-Defined Enums"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"api-suite-fundamentals/flute-defined-enums"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flute-Defined Enums"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h1","attrs":{"style":{"marginTop":"-12px","marginBottom":"4px"}}},"children":[]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\n  The following are Flute-defined enumerations and indices used in endpoint fields.\n"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Account Holder Types"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Account Types"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checking"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Savings"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Business Categories"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WebDeveloper"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IndependentSoftwareVendor"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IndependentSalesOrganization"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Credit Card Types"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"id":"card-types"}},"children":[]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MasterCard"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AmericanExpress"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DinersClub"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JCB"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Transaction Creator Types"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"id":"flute-transaction-creator-type"}},"children":[]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ApiToken"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QuickPayment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WebComponent"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MobileApp"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TapToPay"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Partner Statuses"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Suspended"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Partner Business Model Types"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SingleAffiliateModel"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SubAffiliateModel"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Payment Method Types"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ElectronicCheck"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Payment Processor Statuses"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inactive"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Payment Processor Types"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TSYS"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EFT"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Payment Session Statuses"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Completed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Transaction Statuses"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"id":"flute-transaction-statuses"}},"children":[]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available actions"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction status after an approved "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pre-authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capture, Void"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Captured"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction status after approved "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Void"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction status after merchant voids an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request or refunds a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"captured"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not settled) request"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N/A"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction status after merchant refunds a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N/A"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N/A"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction status after successful settlement request. All "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"captured"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions should have status changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially Authorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction status after an approved "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pre-authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request with the approved amount less than initially requested. Indicates that the issuer bank has approved only a portion of the requested payment amount. The exact authorized amount should be checked in the corresponding field."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capture, Void"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informational"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N/A"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"21"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NA"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N/A"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"24"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction status while changing status. This is a temporary status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N/A"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"91"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction status after a denied "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pre-authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sale"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N/A"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"92"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction status after a failure at any type of request"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N/A"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"92"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction status after 7 days in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status (merchant has not captured within this time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"N/A"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Transaction Types"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"id":"flute-transaction-types"}},"children":[]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capture"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Void"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"6"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CardAuthentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RefundWORef"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TipAdjustment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"11"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AchDebit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AchRefund"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AchHold"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"14"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AchUnHold"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"15"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AchCancel"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"16"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AchCredit"},"children":[]}]}]}]}]}]}]}]}],"panels":[]}]}}],"content":{"contentType":"group","meta":{"name":"API Suite Fundamentals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API Suite Fundamentals","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following sections are general information required for using the Flute API suite."},"children":[]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-suite-fundamentals"}],"panels":[]}]}},{"type":"separator","label":"Flute API Reference","content":null},{"type":"group","label":"API Token Authorization","link":"/api-reference/v2/api-token-authorization","routeSlug":"/api-reference/v2/api-token-authorization","items":[{"label":"Obtains or refreshes an API token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/api-token-authorization/get-oauth-token","routeSlug":"/api-reference/v2/api-token-authorization/get-oauth-token","metadata":{"seo":{"title":"Obtains or refreshes an API token","description":"POST {{baseOAuthURL}}/oauth2/token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-oauth-token","name":"Obtains or refreshes an API token","isWebhook":false,"pointer":"/paths/~1oauth2~1token/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Obtains or refreshes an API token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"get-oauth-token"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#baseOAuthURL"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseOAuthURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/oauth2/token"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint obtains or refreshes an API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each Flute endpoint (with the exception of this authentication endpoint) requires an API token, also called an access token)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is an encrypted string generated from a Flute-owned authentication server."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API token is a combination of an authentication of the user and an authorization of the user's permissions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each API token has a limited lifespan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is often 900 seconds, or 15 minutes although the actual value is returned by the authentication call."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the API token expires, it can no longer be used to make calls."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API token must then be obtained anew or refreshed."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"api-token-authorization/get-oauth-token/request/obtaining-api-tokens","deepLinkHash":"/api-token-authorization/get-oauth-token#api-token-authorization/get-oauth-token/request/obtaining-api-tokens"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtaining API Tokens"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two ways to get a valid API token: "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtaining a new token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refreshing an existing token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint for obtaining a new API token or to refresh an existing one is the same."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the request body fields are different."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selecting the appropriate option displays the relevant fields and information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtaining a new token"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new token must be obtained because:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No token exists."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may be from the user just logging in or the previous API token expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The stored "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expired, has been revoked, or gets rejected by the server (such as a refresh attempt failed)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A different API key is being used."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To obtain a new API token, see the call below, selecting "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain a new token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This displays the fields and details needed to make the call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refreshing an existing token"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An existing API token may be refreshed to create a new, valid API token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That existing API token may be currently valid or has expired recently."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The goal is to provide continuous operation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows users to remain authenticated without repeating full credential authentication on every renewal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API token may be refreshed because:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is about to or has already expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is currently available and valid from the most recent API token."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To refresh an API token, see the call below, selecting "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refresh an existing token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This displays the fields and details needed to make the call."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"api-token-authorization/get-oauth-token/request/api-token-types","deepLinkHash":"/api-token-authorization/get-oauth-token#api-token-authorization/get-oauth-token/request/api-token-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Token Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API token types depend on the type of API keys used to create them."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resulting API token type will be one of following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant token if it is created from a merchant API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner token if it is created from a partner API key."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two API keys types are not interchangeable."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most Flute endpoints require a merchant token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint description specifies the required API key type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints requiring a partner token will be explicitly marked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, a merchant token is required."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_188"}},"schemaId":"schema_188","pointer":"/paths/~1oauth2~1token/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/oauth2/token","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/x-www-form-urlencoded":{"schemaId":"schema_188"}},"responseCodes":["200","400","401","500"],"pointer":"/oauth2/token","href":"api-token-authorization/get-oauth-token","openApiOperationId":"get-oauth-token","summary":"Obtains or refreshes an API token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"schema_188","mediaTypes":["application/x-www-form-urlencoded"],"mediaTypeSchemas":{"application/x-www-form-urlencoded":{"schemaId":"schema_188"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The API token was issued successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_189"}},"schemaId":"schema_189"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1oauth2~1token/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1oauth2~1token/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1oauth2~1token/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1oauth2~1token/post/responses/401/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1oauth2~1token/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1oauth2~1token/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1oauth2~1token/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_189","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_189"}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1oauth2~1token/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1oauth2~1token/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1oauth2~1token/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1oauth2~1token/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1oauth2~1token/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1oauth2~1token/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-token-authorization/get-oauth-token"}],"panels":[]}]},"httpPath":"/oauth2/token"}],"content":{"contentType":"group","meta":{"name":"API Token Authorization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API Token Authorization","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"generating-an-api-token"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API token is required for each endpoint use."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API token can only be created after an account is created, registered, and at least one API key has been created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API token is an authorization token needed for each for endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is an encrypted string that combines the client Id and client secret from an API key (created earlier)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It contains authentication and authorization coding."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes any privileges the user or account affords."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Being encrypted means the API token is safe to expose in frontend code."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API token is time-sensitive and expires after an amount of time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It may be created as needed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend generating a new API token before each endpoint use."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This ensures the API token will be valid for each call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"baseOAuthURL"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API token is an OAuth 2.0 Client Credentials authorization flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Client Credentials Flow is an OAuth 2.0 authorization Bearer grant."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This means a server-side application obtains an access token using its client credentials (client ID and client secret) to protect resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h3","attrs":{"style":{"marginTop":"24px","marginBottom":"4px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Base authorization URLs"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"\nAn API token is created for the environment it will be used in.\nThere are two available Flute environments: Sandbox and Production.\n"},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the sandbox environment for development and testing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No payments, charges, or invoices will be enforced."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST https://sandbox.oauth.api.flute.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the production environment for deploying the payment system live to clients."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All payments, charges, or invoices will be enforced."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST https://oauth.api.flute.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sandbox and production environments API tokens use the same API key and differentiated only by the environment endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two API tokens types are not interchangeable and cannot be used in an environment different than they were created for."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API key that was created in the initial account registration is needed to create an API token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client secret"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are used together to create an API token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is an example of obtaining an API token for the sandbox environment:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X 'POST' 'https://sandbox.oauth.api.flute.com/oauth2/token' \\\n-u '594838709594...38697242c:9eb2c6859daa4...d8ae5da9' \\\n-H 'Content-Type: application/x-www-form-urlencoded' \\\n-d 'grant_type=client_credentials&scope=offline_access'\n","language":"shell"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X 'POST' 'https://sandbox.oauth.api.flute.com/oauth2/token' \\\n-u '594838709594...38697242c:9eb2c6859daa4...d8ae5da9' \\\n-H 'Content-Type: application/x-www-form-urlencoded' \\\n-d 'grant_type=client_credentials&scope=offline_access'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is an example of refreshing an API token for the sandbox environment:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X 'POST' 'https://sandbox.oauth.api.flute.com/oauth2/token' \\\n-u '594838709594...38697242c:9eb2c6859daa4...d8ae5da9' \\\n-H 'Content-Type: application/x-www-form-urlencoded' \\\n-d 'grant_type=refresh_token&refresh_token=def50200newrefresh123456789'\n","language":"shell"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X 'POST' 'https://sandbox.oauth.api.flute.com/oauth2/token' \\\n-u '594838709594...38697242c:9eb2c6859daa4...d8ae5da9' \\\n-H 'Content-Type: application/x-www-form-urlencoded' \\\n-d 'grant_type=refresh_token&refresh_token=def50200newrefresh123456789'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regardless of either obtaining or refreshing an API token, the following example is passed back in the response body:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n\"access_token\": \"u7BYwJx26U1lT...TZpKvndLCC4\",\n\"refresh_token\": \"def50200newrefresh123456789\",\n\"token_type\": \"Bearer\",\n\"expires_in\": 900\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n\"access_token\": \"u7BYwJx26U1lT...TZpKvndLCC4\",\n\"refresh_token\": \"def50200newrefresh123456789\",\n\"token_type\": \"Bearer\",\n\"expires_in\": 900\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h3","attrs":{"style":{"marginTop":"24px","marginBottom":"4px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Using the API Token"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token endpoint returns both an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lifespan of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is indicated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lifespan of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set by OAuth standards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients are encouraged to use either token as needed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, it may be easier to call for a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before each user-initiated action."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may also be left to expire, and then use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" procedures to continue."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, mobile phones apps may need to use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to avoid consistently signing back in."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the endpoint header, use the following "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\"Authorization\": \"Bearer u7BYwJx26U1lT...TZpKvndLCC4\"\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\"Authorization\": \"Bearer u7BYwJx26U1lT...TZpKvndLCC4\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following example creates a new access token:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl 'https://sandbox.api.flute.com/v2/transactions' \\\n-H 'Authorization: Bearer u7BYwJx26U1lT...TZpKvndLCC44' \\\n-H 'Accept: application/json'\n","language":"shell"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl 'https://sandbox.api.flute.com/v2/transactions' \\\n-H 'Authorization: Bearer u7BYwJx26U1lT...TZpKvndLCC44' \\\n-H 'Accept: application/json'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As a reminder, always secure your client ID and especially your client secret."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Never expose the client secret in client-side code or public repositories."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It should be kept private and secure."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If it is suspected that the client secret has been compromised, the owning API key must be deleted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new API key can then be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"h3","attrs":{"style":{"marginTop":"24px","marginBottom":"4px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Error Responses"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If authentication fails, the token endpoint returns an error."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following are commonly encountered errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Cause"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or invalid grant_type, or malformed request body."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API token has likely expired. Create a new one and retry the request."},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/oauth2/token","summary":"Obtains or refreshes an API token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-token-authorization/get-oauth-token","deprecated":false}]}]}]}]}},{"type":"group","label":"Customers","link":"/api-reference/v2/customers","routeSlug":"/api-reference/v2/customers","items":[{"label":"Lists customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/customers/flute-v2-get-customers","routeSlug":"/api-reference/v2/customers/flute-v2-get-customers","metadata":{"seo":{"title":"Lists customers","description":"GET {{baseURL}}/v2/customers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-customers","name":"Lists customers","isWebhook":false,"pointer":"/paths/~1v2~1customers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists customers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-customers"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/customers"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new customer, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/customers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a customer by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/customers/{customerId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a customer, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/customers/{customerId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"style":{"fontSize":"8pt"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n  [ "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"#get_v2_customers_query_parameters"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Query parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ]\n  [ "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"#get_v2_customers_response_body"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Response body"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ]\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"get_v2_customers_query_parameters"}},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageIndex","in":"query","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the page number of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value restrictions include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value less than zero is not permitted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values equal to or greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end successfully but will not return any items."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page size information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 0"},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of items for each page of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page numbering information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 50"},"children":[]}]}]}]},{"name":"asc","in":"query","schemaId":"schema_192","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sort order is ascending."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort field is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the sort order is ascending."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the sort order is descending."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_193","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the field the results get ordered or sorted by."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort order is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field that gets sorted by is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"example":"ContactName"},{"name":"fullName","in":"query","schemaId":"schema_194","description":"Filters by the full name."},{"name":"email","in":"query","schemaId":"schema_195","description":"Filters by an email.\n"},{"name":"companyName","in":"query","schemaId":"schema_196","description":"Filters by a company name.\n"},{"name":"mobilePhoneNumber","in":"query","schemaId":"schema_197","description":"Filters by a mobile phone number.\n\nFree-form search input, E.164 format is not required.\nThis allows partial digits or legacy formats.\n"},{"name":"createdFrom","in":"query","schemaId":"schema_198","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters by the earliest inclusive created date (in an ISO 8601 date-time UTC format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to the present."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an inclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an inclusive range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"createdTo","in":"query","schemaId":"schema_199","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters by the latest inclusive created date (in an ISO 8601 date-time UTC format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to the present."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an inclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an inclusive range to avoid a potentially excessive number of returns."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1customers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/customers","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"pageIndex","in":"query","schemaId":"schema_190"},{"name":"pageSize","in":"query","schemaId":"schema_191"},{"name":"asc","in":"query","schemaId":"schema_192"},{"name":"sortBy","in":"query","example":"ContactName","schemaId":"schema_193"},{"name":"fullName","in":"query","example":"Alexandro Peppared","schemaId":"schema_194"},{"name":"email","in":"query","example":"pepparedstreetcafe@example.com","schemaId":"schema_195"},{"name":"companyName","in":"query","example":"Peppared Street Cafe","schemaId":"schema_196"},{"name":"mobilePhoneNumber","in":"query","example":"+14155552309","schemaId":"schema_197"},{"name":"createdFrom","in":"query","required":false,"example":"2026-02-19T20:24:52.934Z","schemaId":"schema_198"},{"name":"createdTo","in":"query","required":false,"example":"2026-03-06T14:24:52.934Z","schemaId":"schema_199"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v2/customers","href":"customers/flute-v2-get-customers","openApiOperationId":"flute-v2-get-customers","summary":"Lists customers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"get_v2_customers_response_body"}},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfListCustomersResponseDto","exampleIds":["paths/~1v2~1customers/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PageOfListCustomersResponseDto","exampleIds":["paths/~1v2~1customers/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1customers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfListCustomersResponseDto","exampleIds":["paths/~1v2~1customers/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfListCustomersResponseDto","exampleIds":["paths/~1v2~1customers/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/flute-v2-get-customers"}],"panels":[]}]},"httpPath":"/v2/customers"},{"label":"Creates a customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/customers/flute-v2-post-customers","routeSlug":"/api-reference/v2/customers/flute-v2-post-customers","metadata":{"seo":{"title":"Creates a customer","description":"POST {{baseURL}}/v2/customers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-customers","name":"Creates a customer","isWebhook":false,"pointer":"/paths/~1v2~1customers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-customers"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/customers"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint creates a customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list customers, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/customers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a customer by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/customers/{customerId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a customer, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/customers/{customerId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete a customer, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/customers/{customerId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCustomerRequestDto","exampleIds":["paths/~1v2~1customers/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateCustomerRequestDto","exampleIds":["paths/~1v2~1customers/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1customers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/customers","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCustomerRequestDto","exampleIds":["paths/~1v2~1customers/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v2/customers","href":"customers/flute-v2-post-customers","openApiOperationId":"flute-v2-post-customers","summary":"Creates a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/CreateCustomerRequestDto","exampleIds":["paths/~1v2~1customers/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCustomerRequestDto","exampleIds":["paths/~1v2~1customers/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateCustomerResponseDto","exampleIds":["paths/~1v2~1customers/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreateCustomerResponseDto","exampleIds":["paths/~1v2~1customers/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/404/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1customers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateCustomerResponseDto","exampleIds":["paths/~1v2~1customers/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateCustomerResponseDto","exampleIds":["paths/~1v2~1customers/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/flute-v2-post-customers"}],"panels":[]}]},"httpPath":"/v2/customers"},{"label":"Retrieves a customer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/customers/flute-v2-get-customers-customerid","routeSlug":"/api-reference/v2/customers/flute-v2-get-customers-customerid","metadata":{"seo":{"title":"Retrieves a customer by ID","description":"GET {{baseURL}}/v2/customers/{{customerId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-customers-customerId","name":"Retrieves a customer by ID","isWebhook":false,"pointer":"/paths/~1v2~1customers~1{customerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a customer by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-customers-customerId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/customers/{{customerId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a customer by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new customer, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/customers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list customers, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/customers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a customer, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/customers/{customerId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete a customer, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/customers/{customerId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_200","description":"Specifies a customer's identifier.\n","required":true}],"pointer":"/paths/~1v2~1customers~1{customerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/customers/{customerId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":"c4b210e9-be39-4ebc-8195-0c422de87f90","schemaId":"schema_200"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v2/customers/{customerId}","href":"customers/flute-v2-get-customers-customerid","openApiOperationId":"flute-v2-get-customers-customerId","summary":"Retrieves a customer by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCustomerResponseDto","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetCustomerResponseDto","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1customers~1{customerId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCustomerResponseDto","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCustomerResponseDto","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/flute-v2-get-customers-customerid"}],"panels":[]}]},"httpPath":"/v2/customers/{customerId}"},{"label":"Updates a customer's information","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/customers/flute-v2-patch-customers-customerid","routeSlug":"/api-reference/v2/customers/flute-v2-patch-customers-customerid","metadata":{"seo":{"title":"Updates a customer's information","description":"PATCH {{baseURL}}/v2/customers/{{customerId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-patch-customers-customerId","name":"Updates a customer's information","isWebhook":false,"pointer":"/paths/~1v2~1customers~1{customerId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a customer's information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-patch-customers-customerId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PATCH {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/customers/{{customerId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint updates a customer's information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is a partial update."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send only the fields needed to be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An omitted field is left unchanged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A field marked with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" clears a field."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nested structures are also affected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new customer, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/customers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list customers, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/customers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a customer by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/customers/{customerId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete a customer, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/customers/{customerId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_200","description":"Specifies a customer's identifier.\n","required":true}],"pointer":"/paths/~1v2~1customers~1{customerId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomerRequestDto","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateCustomerRequestDto","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1customers~1{customerId}/patch/requestBody","description":"The customer fields to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/customers/{customerId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":"c4b210e9-be39-4ebc-8195-0c422de87f90","schemaId":"schema_200"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCustomerRequestDto","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/customers/{customerId}","href":"customers/flute-v2-patch-customers-customerid","openApiOperationId":"flute-v2-patch-customers-customerId","summary":"Updates a customer's information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/UpdateCustomerRequestDto","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomerRequestDto","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The customer information was successfully updated."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1customers~1{customerId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/flute-v2-patch-customers-customerid"}],"panels":[]}]},"httpPath":"/v2/customers/{customerId}"},{"label":"Deletes a customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/customers/flute-v2-delete-customers-customerid","routeSlug":"/api-reference/v2/customers/flute-v2-delete-customers-customerid","metadata":{"seo":{"title":"Deletes a customer","description":"DELETE {{baseURL}}/v2/customers/{{customerId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-delete-customers-customerId","name":"Deletes a customer","isWebhook":false,"pointer":"/paths/~1v2~1customers~1{customerId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-delete-customers-customerId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELETE {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/customers/{{customerId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint deletes a customer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new customer, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/customers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list customers, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/customers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a customer by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/customers/{customerId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a customer, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/customers/{customerId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customerId","in":"path","schemaId":"schema_200","description":"Specifies the identifier of the customer to delete.\n","required":true}],"pointer":"/paths/~1v2~1customers~1{customerId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/customers/{customerId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"customerId","in":"path","required":true,"example":"c4b210e9-be39-4ebc-8195-0c422de87f90","schemaId":"schema_200"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/customers/{customerId}","href":"customers/flute-v2-delete-customers-customerid","openApiOperationId":"flute-v2-delete-customers-customerId","summary":"Deletes a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The customer was successfully deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1customers~1{customerId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1customers~1{customerId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/customers/flute-v2-delete-customers-customerid"}],"panels":[]}]},"httpPath":"/v2/customers/{customerId}"}],"content":{"contentType":"group","meta":{"name":"Customers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Customers","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers are entities used to organize and manage saved payment methods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These include billing details, transaction history, and recurring payments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customer record may contain their name, email address, phone number, billing, and shipping addresses."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Having a customer association is not required to pay for transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating a customer"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers may be created in the following ways:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explicitly with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/customers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes full customer details and optional payment methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Merchant Portal. Merchants and their partner can create customers through this portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Implicitly with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-int-api/payment-sessions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When this endpoint's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SaveMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentAndSave"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided, one will be created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Implicitly with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-int-api/invoices/publish"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided, one will be created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values can be reviewed with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/customers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pay transactions"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers may pay transactions in one of three ways:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vaulted payments"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone tokenization, also known as orphan vaulted payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account supported"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vaulted payments"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers can be associated with one or more vaulted payment methods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A vaulted payment method is a securely stored payment credential."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This applies to credit card or bank account payments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A vaulted payment method is a securely stored payment credential."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is considered a more secure method rather than storing the card number directly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That information has previously been tokenized and saved for future use."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vaulted information can be safely accessed through a payment identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is typically used for recurring billing, subscriptions, saved checkout experiences, and card-on-file transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the transaction payment, the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The customer's vaulted payment methods are available for selection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone tokenization"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients may use standalone tokenization, also known as an orphan vaulted payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows a payment method to be vaulted even when the payer has not been recognized as a customer entity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction proceeds using a previously established payment method identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone tokenization is useful when a payment method must be vaulted before a customer profile exists."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes guest checkouts, delayed onboarding, account setup, or card-on-file collection before registration is complete."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the transaction payment, the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This indicates the merchant's orphan vaulted payment method is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounts Supported"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients may use accounts supporting orphan payments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a form of a payment method that temporarily exists without a customer association."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the transaction payment, both fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are omitted."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction uses the credit or debit card, or bank account data supplied in the request."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/customers","summary":"Lists customers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/flute-v2-get-customers","deprecated":false},{"title":"/v2/customers","summary":"Creates a customer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/customers/flute-v2-post-customers","deprecated":false},{"title":"/v2/customers/{customerId}","summary":"Retrieves a customer by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/customers/flute-v2-get-customers-customerid","deprecated":false},{"title":"/v2/customers/{customerId}","summary":"Updates a customer's information","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/customers/flute-v2-patch-customers-customerid","deprecated":false},{"title":"/v2/customers/{customerId}","summary":"Deletes a customer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/customers/flute-v2-delete-customers-customerid","deprecated":false}]}]}]}]}},{"type":"group","label":"Merchant API Keys","link":"/api-reference/v2/merchant-api-keys","routeSlug":"/api-reference/v2/merchant-api-keys","items":[{"label":"Lists merchant API keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/merchant-api-keys/flute-v2-get-api-keys","routeSlug":"/api-reference/v2/merchant-api-keys/flute-v2-get-api-keys","metadata":{"seo":{"title":"Lists merchant API keys","description":"GET {{baseURL}}/v2/api-keys"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-api-keys","name":"Lists merchant API keys","isWebhook":false,"pointer":"/paths/~1v2~1api-keys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists merchant API keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-api-keys"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/api-keys"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists merchant's API keys."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create an API key, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/api-keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To revoke an API key, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/api-keys/{{clientId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"merchantId","in":"query","schemaId":"schema_201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a merchant identifier to filter API keys."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the API token used for this endpoint was created from a partner API key, all merchant API keys associated from that partner will be searched."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used to limit the search to a specific merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the API token used for this endpoint was created from a merchant API key, only API keys for that merchant will be returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be omitted."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1api-keys/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/api-keys","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"merchantId","in":"query","example":"8db2ff47-b143-4adb-ab58-a4a017504db2","schemaId":"schema_201"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v2/api-keys","href":"merchant-api-keys/flute-v2-get-api-keys","openApiOperationId":"flute-v2-get-api-keys","summary":"Lists merchant API keys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetApiKeysResponseDto","exampleIds":["paths/~1v2~1api-keys/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetApiKeysResponseDto","exampleIds":["paths/~1v2~1api-keys/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1api-keys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetApiKeysResponseDto","exampleIds":["paths/~1v2~1api-keys/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetApiKeysResponseDto","exampleIds":["paths/~1v2~1api-keys/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-api-keys/flute-v2-get-api-keys"}],"panels":[]}]},"httpPath":"/v2/api-keys"},{"label":"Creates a merchant API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/merchant-api-keys/flute-v2-post-api-keys","routeSlug":"/api-reference/v2/merchant-api-keys/flute-v2-post-api-keys","metadata":{"seo":{"title":"Creates a merchant API key","description":"POST {{baseURL}}/v2/api-keys"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-api-keys","name":"Creates a merchant API key","isWebhook":false,"pointer":"/paths/~1v2~1api-keys/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a merchant API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-api-keys"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/api-keys"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new API key for a merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the API token used for this endpoint was created from a partner API key, an API key can be created only for merchants associated with that partner."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the API token used for this endpoint was created from a merchant API key, an API key can be created only for that merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list available keys, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/api-keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To revoke an API key, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/api-keys/{{clientId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateApiKeyRequestDto","exampleIds":["paths/~1v2~1api-keys/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateApiKeyRequestDto","exampleIds":["paths/~1v2~1api-keys/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1api-keys/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/api-keys","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateApiKeyRequestDto","exampleIds":["paths/~1v2~1api-keys/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/api-keys","href":"merchant-api-keys/flute-v2-post-api-keys","openApiOperationId":"flute-v2-post-api-keys","summary":"Creates a merchant API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/CreateApiKeyRequestDto","exampleIds":["paths/~1v2~1api-keys/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateApiKeyRequestDto","exampleIds":["paths/~1v2~1api-keys/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateApiKeyResponseDto","exampleIds":["paths/~1v2~1api-keys/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreateApiKeyResponseDto","exampleIds":["paths/~1v2~1api-keys/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1api-keys/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateApiKeyResponseDto","exampleIds":["paths/~1v2~1api-keys/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateApiKeyResponseDto","exampleIds":["paths/~1v2~1api-keys/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-api-keys/flute-v2-post-api-keys"}],"panels":[]}]},"httpPath":"/v2/api-keys"},{"label":"Revokes a merchant API key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/merchant-api-keys/flute-v2-delete-api-keys-clientid","routeSlug":"/api-reference/v2/merchant-api-keys/flute-v2-delete-api-keys-clientid","metadata":{"seo":{"title":"Revokes a merchant API key","description":"DELETE {{baseURL}}/v2/api-keys/{{clientId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-delete-api-keys-clientId","name":"Revokes a merchant API key","isWebhook":false,"pointer":"/paths/~1v2~1api-keys~1{clientId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revokes a merchant API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-delete-api-keys-clientId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint","style":{"color":"black","fontSize":"14pt","fontWeight":"450"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELETE {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/api-keys/{{clientId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint revokes a merchant API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list available keys, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/api-keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create an API key, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/api-keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clientId","in":"path","schemaId":"schema_202","description":"Specifies the API key's client identifier.\n\nIf the API token used for this endpoint was created from a partner API key, an API key can be revoked only for merchants associated with that partner.\n\nIf the API token used for this endpoint was created from a merchant API key, an API key can be revoked only for that merchant.\n","required":true}],"pointer":"/paths/~1v2~1api-keys~1{clientId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/api-keys/{clientId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"clientId","in":"path","required":true,"example":"aa98aa89-07ae-4a23-b441-48725f0386e6","schemaId":"schema_202"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","429","500"],"pointer":"/v2/api-keys/{clientId}","href":"merchant-api-keys/flute-v2-delete-api-keys-clientid","openApiOperationId":"flute-v2-delete-api-keys-clientId","summary":"Revokes a merchant API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The API key was successfully revoked."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/403/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1api-keys~1{clientId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1api-keys~1{clientId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-api-keys/flute-v2-delete-api-keys-clientid"}],"panels":[]}]},"httpPath":"/v2/api-keys/{clientId}"}],"content":{"contentType":"group","meta":{"name":"Merchant API Keys"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merchant API Keys","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API keys may be managed programmatically."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes creating and deleting API keys."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the same capability as through the partner and merchant dashboards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the API keys are managed depends on the source of the API token used for the endpoints."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two sources: Partner and merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A partner API key used to create the API token affects only merchants associated with the partner."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The partner can manage the API keys for their individual merchants."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A partner API key can be created only in the partner dashboard."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A merchant API key used to create an API token that affects only that one merchant."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes both a merchant associated with a partner and standalone merchants (those not associated with any partner)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each merchant API Key endpoint explains the details of using either API token source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API keys are specific to a single merchant."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They are not interchangeable from among different merchants, even if they are each associated with the same partner."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That is, merchants cannot use API keys from any other merchant."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone merchants (those not associated with any partner) manage their API keys through the merchant Flute dashboard."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant API keys are required only if the merchant application or account needs to integrate with the API suite."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A merchant API key is required to create API tokens (also called access tokens), needed to make endpoint calls."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Except for the Merchant API Key endpoints, only merchant API tokens (API tokens created from a merchant API key) can be used with any other endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner API keys cannot be used to create API tokens otherwise."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To generate an API token from an API key, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#get-oauth-token","style":{"textDecoration":"underline"}}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /oauth-token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of API keys is determined by the partner or standalone merchants."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They may have as many or as few as required."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information about API keys, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/docs/getting-started/api-authentication","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating an API Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This Merchant API Key group consists of the following endpoints:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list available keys, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/api-keys"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create an API key, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/api-keys"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To revoke an API key, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/api-keys/{{clientId}}"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/api-keys","summary":"Lists merchant API keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchant-api-keys/flute-v2-get-api-keys","deprecated":false},{"title":"/v2/api-keys","summary":"Creates a merchant API key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchant-api-keys/flute-v2-post-api-keys","deprecated":false},{"title":"/v2/api-keys/{clientId}","summary":"Revokes a merchant API key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/merchant-api-keys/flute-v2-delete-api-keys-clientid","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Methods","link":"/api-reference/v2/payment-methods","routeSlug":"/api-reference/v2/payment-methods","items":[{"label":"Lists a customer's payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/payment-methods/flute-v2-get-payment-methods","routeSlug":"/api-reference/v2/payment-methods/flute-v2-get-payment-methods","metadata":{"seo":{"title":"Lists a customer's payment methods","description":"GET {{baseURL}}/v2/payment-methods"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-payment-methods","name":"Lists a customer's payment methods","isWebhook":false,"pointer":"/paths/~1v2~1payment-methods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists a customer's payment methods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-payment-methods"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/payment-methods"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists a customer's payment methods for the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To add a new card payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-methods/cards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To add a new ACH payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-methods/ach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageIndex","in":"query","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the page number of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value restrictions include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value less than zero is not permitted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values equal to or greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end successfully but will not return any items."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page size information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 0"},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of items for each page of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page numbering information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 50"},"children":[]}]}]}]},{"name":"asc","in":"query","schemaId":"schema_192","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sort order is ascending."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort field is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the sort order is ascending."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the sort order is descending."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_193","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the field the results get ordered or sorted by."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort order is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field that gets sorted by is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"example":"ContactName"},{"name":"search","in":"query","schemaId":"schema_203","description":"Specifies the search string.\n\nThis performs a case-insensitive search that matches exactly or partially.\n"},{"name":"createdFrom","in":"query","schemaId":"schema_198","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters by the earliest inclusive created date (in an ISO 8601 date-time UTC format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to the present."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an inclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an inclusive range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"createdTo","in":"query","schemaId":"schema_199","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters by the latest inclusive created date (in an ISO 8601 date-time UTC format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to the present."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an inclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an inclusive range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"customerId","in":"query","schemaId":"schema_200","description":"Filters by a customer's identifier.\n\nIf null or omitted, the response includes orphan payment methods with customer-linked payment methods.\n"}],"pointer":"/paths/~1v2~1payment-methods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/payment-methods","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"pageIndex","in":"query","schemaId":"schema_190"},{"name":"pageSize","in":"query","schemaId":"schema_191"},{"name":"asc","in":"query","schemaId":"schema_192"},{"name":"sortBy","in":"query","example":"ContactName","schemaId":"schema_193"},{"name":"search","in":"query","example":"Conners Electric","schemaId":"schema_203"},{"name":"createdFrom","in":"query","required":false,"example":"2026-02-19T20:24:52.934Z","schemaId":"schema_198"},{"name":"createdTo","in":"query","required":false,"example":"2026-03-06T14:24:52.934Z","schemaId":"schema_199"},{"name":"customerId","in":"query","example":"c4b210e9-be39-4ebc-8195-0c422de87f90","schemaId":"schema_200"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v2/payment-methods","href":"payment-methods/flute-v2-get-payment-methods","openApiOperationId":"flute-v2-get-payment-methods","summary":"Lists a customer's payment methods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfPaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PageOfPaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1payment-methods/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfPaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfPaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/flute-v2-get-payment-methods"}],"panels":[]}]},"httpPath":"/v2/payment-methods"},{"label":"Creates a card payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/payment-methods/flute-v2-post-payment-methods-cards","routeSlug":"/api-reference/v2/payment-methods/flute-v2-post-payment-methods-cards","metadata":{"seo":{"title":"Creates a card payment method","description":"POST {{baseURL}}/v2/payment-methods/cards"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-payment-methods-cards","name":"Creates a card payment method","isWebhook":false,"pointer":"/paths/~1v2~1payment-methods~1cards/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a card payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-payment-methods-cards"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/payment-methods/cards"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint creates a card (credit or debit) payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card information is tokenized and stored, assigning it to the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokenization means the sensitive payment data, such as the raw card number or bank account number, is submitted to Flute once."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After that, Flute assigns a non-sensitive value to paymentMethodId."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The paymentMethodId is then used as the payment reference for later transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To add a new ACH payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-methods/ach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list payment methods, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCardPaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1cards/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateCardPaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1cards/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1payment-methods~1cards/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/payment-methods/cards","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCardPaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1cards/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/payment-methods/cards","href":"payment-methods/flute-v2-post-payment-methods-cards","openApiOperationId":"flute-v2-post-payment-methods-cards","summary":"Creates a card payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/CreateCardPaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1cards/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCardPaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1cards/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreatePaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1payment-methods~1cards/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatePaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1cards/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/flute-v2-post-payment-methods-cards"}],"panels":[]}]},"httpPath":"/v2/payment-methods/cards"},{"label":"Creates an ACH payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/payment-methods/flute-v2-post-payment-methods-ach","routeSlug":"/api-reference/v2/payment-methods/flute-v2-post-payment-methods-ach","metadata":{"seo":{"title":"Creates an ACH payment method","description":"POST {{baseURL}}/v2/payment-methods/ach"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-payment-methods-ach","name":"Creates an ACH payment method","isWebhook":false,"pointer":"/paths/~1v2~1payment-methods~1ach/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates an ACH payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-payment-methods-ach"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/payment-methods/ach"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint creates an ACH (automated clearing house) payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ACH account information is tokenized and stored, assigning it to the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokenization means the sensitive payment data, such as the ACH account number or bank account number, is submitted to Flute once."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After that, Flute assigns a non-sensitive value to paymentMethodId."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The paymentMethodId is then used as the payment reference for later transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Business ACH where the orphan caller will not supply ContactInfo on transactions, include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"companyName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so the legal entity name is available at transaction time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To add a new card payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-methods/cards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list payment methods, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a payment method by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAchPaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1ach/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateAchPaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1ach/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1payment-methods~1ach/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/payment-methods/ach","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAchPaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1ach/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/payment-methods/ach","href":"payment-methods/flute-v2-post-payment-methods-ach","openApiOperationId":"flute-v2-post-payment-methods-ach","summary":"Creates an ACH payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/CreateAchPaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1ach/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAchPaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1ach/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreatePaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1payment-methods~1ach/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatePaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1ach/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/flute-v2-post-payment-methods-ach"}],"panels":[]}]},"httpPath":"/v2/payment-methods/ach"},{"label":"Retrieves a payment method by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/payment-methods/flute-v2-get-payment-methods-paymentmethodid","routeSlug":"/api-reference/v2/payment-methods/flute-v2-get-payment-methods-paymentmethodid","metadata":{"seo":{"title":"Retrieves a payment method by ID","description":"GET {{baseURL}}/v2/payment-methods/{{paymentMethodId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-payment-methods-paymentMethodId","name":"Retrieves a payment method by ID","isWebhook":false,"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a payment method by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-payment-methods-paymentMethodId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/payment-methods/{{paymentMethodId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a payment method by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To add a new card payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-methods/cards"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To add a new ACH payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-methods/ach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a payment method by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentMethodId","in":"path","schemaId":"schema_204","description":"The payment method identifier.","required":true}],"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/payment-methods/{paymentMethodId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"paymentMethodId","in":"path","required":true,"example":"c24e0199-7e8e-49b0-ac09-16aae93af4be","schemaId":"schema_204"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v2/payment-methods/{paymentMethodId}","href":"payment-methods/flute-v2-get-payment-methods-paymentmethodid","openApiOperationId":"flute-v2-get-payment-methods-paymentMethodId","summary":"Retrieves a payment method by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/200/content/application~1json/examples/Card payment method (customer-linked, default)","paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/200/content/application~1json/examples/ACH payment method (orphan, business)"]}},"schemaId":"components/schemas/PaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/200/content/application~1json/examples/Card payment method (customer-linked, default)","paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/200/content/application~1json/examples/ACH payment method (orphan, business)"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/200/content/application~1json/examples/Card payment method (customer-linked, default)","paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/200/content/application~1json/examples/ACH payment method (orphan, business)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentMethodResponseDto","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/200/content/application~1json/examples/Card payment method (customer-linked, default)","paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/200/content/application~1json/examples/ACH payment method (orphan, business)"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/flute-v2-get-payment-methods-paymentmethodid"}],"panels":[]}]},"httpPath":"/v2/payment-methods/{paymentMethodId}"},{"label":"Updates a payment method","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/payment-methods/flute-v2-patch-payment-methods-paymentmethodid","routeSlug":"/api-reference/v2/payment-methods/flute-v2-patch-payment-methods-paymentmethodid","metadata":{"seo":{"title":"Updates a payment method","description":"PATCH {{baseURL}}/v2/payment-methods/{{paymentMethodId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-patch-payment-methods-paymentMethodId","name":"Updates a payment method","isWebhook":false,"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-patch-payment-methods-paymentMethodId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PATCH {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/payment-methods/{{paymentMethodId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint updates a payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Renames the payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is a partial update."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send only the fields needed to be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An omitted field is left unchanged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A field marked with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" clears a field."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nested structures are also affected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment method is identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" within the merchant."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation works the same for orphan and customer-linked payment methods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list payment methods, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a payment method by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete a payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To set a payment method as the default, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-methods/{{paymentMethodId}}/set-default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentMethodId","in":"path","schemaId":"schema_205","description":"Specifies the payment method identifier.\n","required":true}],"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdatePaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}/patch/requestBody","description":"The payment method fields to update.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/payment-methods/{paymentMethodId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"paymentMethodId","in":"path","required":true,"example":"c857af4c-ced9-4b79-b39b-13c077711d7e","schemaId":"schema_205"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdatePaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/payment-methods/{paymentMethodId}","href":"payment-methods/flute-v2-patch-payment-methods-paymentmethodid","openApiOperationId":"flute-v2-patch-payment-methods-paymentMethodId","summary":"Updates a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/UpdatePaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdatePaymentMethodRequestDto","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The payment method was successfully updated."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/flute-v2-patch-payment-methods-paymentmethodid"}],"panels":[]}]},"httpPath":"/v2/payment-methods/{paymentMethodId}"},{"label":"Deletes a payment method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/payment-methods/flute-v2-delete-payment-methods-paymentmethodid","routeSlug":"/api-reference/v2/payment-methods/flute-v2-delete-payment-methods-paymentmethodid","metadata":{"seo":{"title":"Deletes a payment method","description":"DELETE {{baseURL}}/v2/payment-methods/{{paymentMethodId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-delete-payment-methods-paymentMethodId","name":"Deletes a payment method","isWebhook":false,"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-delete-payment-methods-paymentMethodId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELETE {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/payment-methods/{{paymentMethodId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint deletes a payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list payment methods, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a payment method by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To set a payment method as the default, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-methods/{{paymentMethodId}}/set-default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentMethodId","in":"path","schemaId":"schema_206","description":"Specifies the payment method identifier to delete.\n","required":true}],"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/payment-methods/{paymentMethodId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"paymentMethodId","in":"path","required":true,"example":"a6ae6a86-6831-4422-a646-d9442a1b0ec8","schemaId":"schema_206"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/payment-methods/{paymentMethodId}","href":"payment-methods/flute-v2-delete-payment-methods-paymentmethodid","openApiOperationId":"flute-v2-delete-payment-methods-paymentMethodId","summary":"Deletes a payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The payment method was successfully deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/flute-v2-delete-payment-methods-paymentmethodid"}],"panels":[]}]},"httpPath":"/v2/payment-methods/{paymentMethodId}"},{"label":"Sets a default payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/payment-methods/flute-v2-post-payment-methods-paymentmethodid-set-default","routeSlug":"/api-reference/v2/payment-methods/flute-v2-post-payment-methods-paymentmethodid-set-default","metadata":{"seo":{"title":"Sets a default payment method","description":"POST {{baseURL}}/v2/payment-methods/{{paymentMethodId}}/set-default"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-payment-methods-paymentMethodId-set-default","name":"Sets a default payment method","isWebhook":false,"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sets a default payment method","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-payment-methods-paymentMethodId-set-default"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/payment-methods/{{paymentMethodId}}/set-default"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint set the specified payment method as the default payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only one payment method can be set as the default."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set, the previous default payment method, if there was one, is changed to not being the default."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only customer-linked payment methods can be made default; CustomerId is therefore required."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orphan PMs (no linked customer) have no concept of default and cannot reach this endpoint without a customer scope."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list payment methods, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-methods"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a payment method by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete a payment method, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/payment-methods/{{paymentMethodId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentMethodId","in":"path","schemaId":"schema_207","description":"Specifies the payment method identifier to set as default.","required":true}],"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"customerId","in":"query","schemaId":"schema_200","description":"Specifies a customer's identifier.\n","required":true}],"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/payment-methods/{paymentMethodId}/set-default","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"paymentMethodId","in":"path","required":true,"example":"1a4f15c9-f39c-49f1-aad5-04e0e72804ad","schemaId":"schema_207"}],"query":[{"name":"customerId","in":"query","required":true,"example":"c4b210e9-be39-4ebc-8195-0c422de87f90","schemaId":"schema_200"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","409","429","500"],"pointer":"/v2/payment-methods/{paymentMethodId}/set-default","href":"payment-methods/flute-v2-post-payment-methods-paymentmethodid-set-default","openApiOperationId":"flute-v2-post-payment-methods-paymentMethodId-set-default","summary":"Sets a default payment method"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The payment method was set as the default."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/401/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/402/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/401/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-methods/flute-v2-post-payment-methods-paymentmethodid-set-default"}],"panels":[]}]},"httpPath":"/v2/payment-methods/{paymentMethodId}/set-default"}],"content":{"contentType":"group","meta":{"name":"Payment Methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Methods","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"payment-methods-overview"}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment method is a stored, tokenized payment record that can be used to process transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A stored record is created once and may be used for all future transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes submitting the raw card and account details only once, when it is first created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokenization means the sensitive payment data, such as the raw card number or bank account number, is submitted to Flute once."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After that, Flute assigns a non-sensitive value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is then used as the payment reference for later transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment methods can be set to one of the following types: linked to a customer or an orphan."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Linked to a customer"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A customer is a defined business entity."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information includes the company name, the owner's name, billing and shipping addresses, and different kinds of payment methods."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rather than re-entering the information, it can be saved and used later as needed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment method linked to a customer can be used by referencing the customer using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An orphan"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An orphan payment method is a stored payment method (card or ACH account) that belongs to the merchant directly."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the customerId is omitted from the payment method, the payment method is created as an orphan."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It exists in the merchant's vault but has no customer record associated with it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A practical use case would be for a one-time transaction that uses a tokenize card but without creating a full customer profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two types of payment method: Cards and ACH."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cards"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit or debit cards are stored as a token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The raw card number is never fully displayed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It always uses a masked card number, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"************1111"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment type includes a card type (such as Visa or MasterCard), credit or debit card type, expiration date, and an optional payment name, a name recognizable to the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH accounts"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH accounts are electronic bank accounts transfers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They are stored with routing number, account number, account type (Checking/Savings), and account holder type (Personal/Business)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business ACH accounts also carry a payment name, a name recognizable to the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either can be marked as the default payment method for a customer but only one payment method may set as the default at a time."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/payment-methods","summary":"Lists a customer's payment methods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-methods/flute-v2-get-payment-methods","deprecated":false},{"title":"/v2/payment-methods/cards","summary":"Creates a card payment method","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/flute-v2-post-payment-methods-cards","deprecated":false},{"title":"/v2/payment-methods/ach","summary":"Creates an ACH payment method","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/flute-v2-post-payment-methods-ach","deprecated":false},{"title":"/v2/payment-methods/{paymentMethodId}","summary":"Retrieves a payment method by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-methods/flute-v2-get-payment-methods-paymentmethodid","deprecated":false},{"title":"/v2/payment-methods/{paymentMethodId}","summary":"Updates a payment method","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/payment-methods/flute-v2-patch-payment-methods-paymentmethodid","deprecated":false},{"title":"/v2/payment-methods/{paymentMethodId}","summary":"Deletes a payment method","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-methods/flute-v2-delete-payment-methods-paymentmethodid","deprecated":false},{"title":"/v2/payment-methods/{paymentMethodId}/set-default","summary":"Sets a default payment method","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-methods/flute-v2-post-payment-methods-paymentmethodid-set-default","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Sessions","link":"/api-reference/v2/payment-sessions","routeSlug":"/api-reference/v2/payment-sessions","items":[{"label":"Creates a new payment session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/payment-sessions/flute-v2-post-payment-sessions","routeSlug":"/api-reference/v2/payment-sessions/flute-v2-post-payment-sessions","metadata":{"seo":{"title":"Creates a new payment session","description":"POST {{baseURL}}/v2/payment-sessions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-payment-sessions","name":"Creates a new payment session","isWebhook":false,"pointer":"/paths/~1v2~1payment-sessions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new payment session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-payment-sessions"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/payment-sessions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint creates a new payment session."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a payment session by Id, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-sessions/{{paymentSessionId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To cancel a payment session, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-sessions/{{paymentSessionId}}/cancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePaymentSessionRequestDto"}},"schemaId":"components/schemas/CreatePaymentSessionRequestDto","pointer":"/paths/~1v2~1payment-sessions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/payment-sessions","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePaymentSessionRequestDto"}},"responseCodes":["200","400","500"],"pointer":"/v2/payment-sessions","href":"payment-sessions/flute-v2-post-payment-sessions","openApiOperationId":"flute-v2-post-payment-sessions","summary":"Creates a new payment session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/CreatePaymentSessionRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePaymentSessionRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePaymentSessionResponseDto"}},"schemaId":"components/schemas/CreatePaymentSessionResponseDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1payment-sessions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatePaymentSessionResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePaymentSessionResponseDto"}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-sessions/flute-v2-post-payment-sessions"}],"panels":[]}]},"httpPath":"/v2/payment-sessions"},{"label":"Retrieves payment session details by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/payment-sessions/flute-v2-get-payment-sessions-paymentsessionid","routeSlug":"/api-reference/v2/payment-sessions/flute-v2-get-payment-sessions-paymentsessionid","metadata":{"seo":{"title":"Retrieves payment session details by ID","description":"GET {{baseURL}}/v2/payment-sessions/{{paymentSessionId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-payment-sessions-paymentSessionId","name":"Retrieves payment session details by ID","isWebhook":false,"pointer":"/paths/~1v2~1payment-sessions~1{paymentSessionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves payment session details by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-payment-sessions-paymentSessionId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/payment-sessions/{{paymentSessionId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the details of the specified payment session by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new payment session, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-sessions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To cancel a payment session, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-sessions/{{paymentSessionId}}/cancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentSessionId","in":"path","schemaId":"schema_208","description":"Specifies the payment session identifier.\n","required":true}],"pointer":"/paths/~1v2~1payment-sessions~1{paymentSessionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/payment-sessions/{paymentSessionId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"paymentSessionId","in":"path","required":true,"example":"edf7b36a-1b2c-4d3e-4f5a-6b7c8d9e0f36","schemaId":"schema_208"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v2/payment-sessions/{paymentSessionId}","href":"payment-sessions/flute-v2-get-payment-sessions-paymentsessionid","openApiOperationId":"flute-v2-get-payment-sessions-paymentSessionId","summary":"Retrieves payment session details by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPaymentSessionResponseDto"}},"schemaId":"components/schemas/GetPaymentSessionResponseDto"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetPaymentSessionResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPaymentSessionResponseDto"}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-sessions/flute-v2-get-payment-sessions-paymentsessionid"}],"panels":[]}]},"httpPath":"/v2/payment-sessions/{paymentSessionId}"},{"label":"Cancels a payment session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/payment-sessions/flute-v2-post-payment-sessions-paymentsessionid-cancel","routeSlug":"/api-reference/v2/payment-sessions/flute-v2-post-payment-sessions-paymentsessionid-cancel","metadata":{"seo":{"title":"Cancels a payment session","description":"POST {{baseURL}}/v2/payment-sessions/{{paymentSessionId}}/cancel"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-payment-sessions-paymentSessionId-cancel","name":"Cancels a payment session","isWebhook":false,"pointer":"/paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancels a payment session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-payment-sessions-paymentSessionId-cancel"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/payment-sessions/{{paymentSessionId}}/cancel"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint cancels a payment session."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment session can only be canceled successfully if:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment session must belong to the requesting merchant."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the API token must match the session's merchant."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It returns 403 Forbidden if it does not."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The session is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any other status, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", fails with the validation error: \"Payment Session can be canceled only in Created status\"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new payment session, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-sessions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a payment session by Id, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-sessions/{{paymentSessionId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"paymentSessionId","in":"path","schemaId":"schema_208","description":"Specifies the payment session identifier.\n","required":true}],"pointer":"/paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/payment-sessions/{paymentSessionId}/cancel","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"paymentSessionId","in":"path","required":true,"example":"edf7b36a-1b2c-4d3e-4f5a-6b7c8d9e0f36","schemaId":"schema_208"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v2/payment-sessions/{paymentSessionId}/cancel","href":"payment-sessions/flute-v2-post-payment-sessions-paymentsessionid-cancel","openApiOperationId":"flute-v2-post-payment-sessions-paymentSessionId-cancel","summary":"Cancels a payment session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The payment session was successfully cancelled."},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-sessions/flute-v2-post-payment-sessions-paymentsessionid-cancel"}],"panels":[]}]},"httpPath":"/v2/payment-sessions/{paymentSessionId}/cancel"}],"content":{"contentType":"group","meta":{"name":"Payment Sessions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Sessions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"payment-sessions-overview"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment session is an in-progress payment transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is a temporary, time-limited context created when a client initiates a payment flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It becomes a secure, stateful environment for completing a payment transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instead of passing sensitive payment data on every request, the payment session persists transaction details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes the amount, currency, payment method, and status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It exposes only the payment session identifier to the client."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This reduces the risk of data exposure."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The use of a payment session is applicable only to Flute Elements and Flute Checkout."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some fields may include a note about their use, and specifically for Elements and Checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is a common workflow for using a payment session."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create the payment session."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connect through Flute Elements or Flute Checkout."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may include selecting a payment method, applying discounts or promotions,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorizing the payment, and capturing the funds."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Many of these individual steps will be transparent to the client when using Flute Elements or Flute Checkout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At each step, the payment session holds the transaction state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This means each step can update the session without resubmitting the full transaction data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the client navigates away but later returns or does not complete the transaction immediately, the session can be retrieved by its identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The flow resumed from where it left off."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment session can end in one of the following ways:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction is completed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the status of the transaction for its success."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/payment-sessions/{{paymentSessionId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction is canceled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client chooses to not complete the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the client cannot later resume the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new payment session must be started."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment session expires or times out."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a payment session, an expiration date and time can be assigned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the transaction is neither completed nor explicitly canceled, the payment session cancels itself."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Like the cancel operation, the state of the transaction is saved."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client may retrieve the payment session later and continue the transaction."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/payment-sessions","summary":"Creates a new payment session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-sessions/flute-v2-post-payment-sessions","deprecated":false},{"title":"/v2/payment-sessions/{paymentSessionId}","summary":"Retrieves payment session details by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-sessions/flute-v2-get-payment-sessions-paymentsessionid","deprecated":false},{"title":"/v2/payment-sessions/{paymentSessionId}/cancel","summary":"Cancels a payment session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-sessions/flute-v2-post-payment-sessions-paymentsessionid-cancel","deprecated":false}]}]}]}]}},{"type":"group","label":"Ping","link":"/api-reference/v2/ping","routeSlug":"/api-reference/v2/ping","items":[{"label":"Pings an endpoint for health status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/ping/flute-v2-get-ping","routeSlug":"/api-reference/v2/ping/flute-v2-get-ping","metadata":{"seo":{"title":"Pings an endpoint for health status","description":"GET {{baseURL}}/v2/ping"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-ping","name":"Pings an endpoint for health status","isWebhook":false,"pointer":"/paths/~1v2~1ping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pings an endpoint for health status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-ping"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/ping"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint pings an endpoint to validate the API token is active and valid."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 200 OK if the service is reachable."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is no response body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/ping","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/ping","href":"ping/flute-v2-get-ping","openApiOperationId":"flute-v2-get-ping","summary":"Pings an endpoint for health status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The service is available."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/403/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1ping/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1ping/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ping/flute-v2-get-ping"}],"panels":[]}]},"httpPath":"/v2/ping"}],"content":{"contentType":"group","meta":{"name":"Ping"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ping","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ping is a health check endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It verifies the service is currently reachable."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This also checks that an API token is still valid."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a simple endpoint call."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It takes no parameters and returns no response body."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful call returns only a 200 OK."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That minimalism is intentional."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is typically hit frequently and automatically rather than as part of real business logic."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is useful as:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an application startup check when an integration boots."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a periodic keep-alive in a monitoring dashboard,"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a quick manual test after rotating an API key."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It shares the same error-handling shape as every other endpoint, such as response codes for 400, 401, 403, 429, or 500."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These error response codes are diagnostically useful, too."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a response code of 401 indicates the API token is bad or expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ping a webhook endpoint, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/webhooks/endpoints/{{webhookId}}/ping"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/ping","summary":"Pings an endpoint for health status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ping/flute-v2-get-ping","deprecated":false}]}]}]}]}},{"type":"group","label":"POS Transactions","link":"/api-reference/v2/pos-transactions","routeSlug":"/api-reference/v2/pos-transactions","items":[{"label":"Lists POS transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/pos-transactions/flute-v2-get-pos-transactions","routeSlug":"/api-reference/v2/pos-transactions/flute-v2-get-pos-transactions","metadata":{"seo":{"title":"Lists POS transactions","description":"GET {{baseURL}}/v2/pos/transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-pos-transactions","name":"Lists POS transactions","isWebhook":false,"pointer":"/paths/~1v2~1pos~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists POS transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-pos-transactions"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/pos/transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists POS transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item in the response contains a reduced transaction object."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields are limited to the most relevant transaction information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is often sufficient for rendering transaction lists, dashboards, and reconciliation views."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Situations requiring full detail context, such as for decline details, AVS response, or transaction events, are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/pos/transactions/{{posTransactionId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a POS transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/pos/transactions/{posTransactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new POS transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/pos/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To cancel a POS transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/pos/transactions/{posTransactionId}/cancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageIndex","in":"query","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the page number of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value restrictions include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value less than zero is not permitted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values equal to or greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end successfully but will not return any items."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page size information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 0"},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of items for each page of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page numbering information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 50"},"children":[]}]}]}]},{"name":"sortOrder","in":"query","schemaId":"schema_209","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sort order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort order is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field that gets sorted by is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"asc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results from the lowest value to the highest value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"desc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results from the highest value to the lowest value."},"children":[]}]}]}]}]}]}],"example":"desc"},{"name":"sortBy","in":"query","schemaId":"schema_193","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the field the results get ordered or sorted by."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort order is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field that gets sorted by is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"example":"ContactName"},{"name":"terminalId","in":"query","schemaId":"schema_210","description":"Specifies to filter by terminal identifier.\n","example":"57dbdbc6-fef4-44b8-816a-4372c063f1ec"},{"name":"fromDate","in":"query","schemaId":"schema_211","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies returning items on or after this date (in an ISO 8601 date-time format) to filter by,."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to the present."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an exclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an exclusive range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"toDate","in":"query","schemaId":"schema_212","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies returning items on or to this date (in an ISO 8601 date-time format) to filter by,."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items up to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an exclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an explicit range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"posTransactionStatus","in":"query","schemaId":"schema_213","example":"Completed"}],"pointer":"/paths/~1v2~1pos~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/pos/transactions","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"pageIndex","in":"query","schemaId":"schema_190"},{"name":"pageSize","in":"query","schemaId":"schema_191"},{"name":"sortOrder","in":"query","example":"desc","schemaId":"schema_209"},{"name":"sortBy","in":"query","example":"ContactName","schemaId":"schema_193"},{"name":"terminalId","in":"query","example":"57dbdbc6-fef4-44b8-816a-4372c063f1ec","schemaId":"schema_210"},{"name":"fromDate","in":"query","example":"2025-01-27T12:05:54.322Z","schemaId":"schema_211"},{"name":"toDate","in":"query","example":"2026-02-27T12:05:54.322Z","schemaId":"schema_212"},{"name":"posTransactionStatus","in":"query","example":"Completed","schemaId":"schema_213"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/pos/transactions","href":"pos-transactions/flute-v2-get-pos-transactions","openApiOperationId":"flute-v2-get-pos-transactions","summary":"Lists POS transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfListPosTransactionsResponseDto","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PageOfListPosTransactionsResponseDto","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/403/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1pos~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfListPosTransactionsResponseDto","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfListPosTransactionsResponseDto","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pos-transactions/flute-v2-get-pos-transactions"}],"panels":[]}]},"httpPath":"/v2/pos/transactions"},{"label":"Creates a POS transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/pos-transactions/flute-v2-post-pos-transactions","routeSlug":"/api-reference/v2/pos-transactions/flute-v2-post-pos-transactions","metadata":{"seo":{"title":"Creates a POS transaction","description":"POST {{baseURL}}/v2/pos/transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-pos-transactions","name":"Creates a POS transaction","isWebhook":false,"pointer":"/paths/~1v2~1pos~1transactions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a POS transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-pos-transactions"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/pos/transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint creates a new card present payment transaction on a semi-Integrated terminal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A semi-integrated terminal is one that is connected to a POS system, typically through a network or cable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When called, the gateway connects to the specified terminal and starts the payment flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes screens for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card type selection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tip entry"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card reading, such as for tap, insert, or swipe, depending on the merchant's settings."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal flow is asynchronous."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /pos/transactions/{{posTransactionId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"posTransactionStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reaches a terminal state, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", check the linked transaction for the payment outcome, which may have been declined."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list POS transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/pos/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a POS transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/pos/transactions/{posTransactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To cancel a POS transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/pos/transactions/{posTransactionId}/cancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePosTransactionRequestDto","exampleIds":["paths/~1v2~1pos~1transactions/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreatePosTransactionRequestDto","exampleIds":["paths/~1v2~1pos~1transactions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1pos~1transactions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/pos/transactions","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreatePosTransactionRequestDto","exampleIds":["paths/~1v2~1pos~1transactions/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","402","403","404","429","500"],"pointer":"/v2/pos/transactions","href":"pos-transactions/flute-v2-post-pos-transactions","openApiOperationId":"flute-v2-post-pos-transactions","summary":"Creates a POS transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/CreatePosTransactionRequestDto","exampleIds":["paths/~1v2~1pos~1transactions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreatePosTransactionRequestDto","exampleIds":["paths/~1v2~1pos~1transactions/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePosTransactionResponseDto","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreatePosTransactionResponseDto","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/401/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/402/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/404/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1pos~1transactions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatePosTransactionResponseDto","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePosTransactionResponseDto","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/401/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pos-transactions/flute-v2-post-pos-transactions"}],"panels":[]}]},"httpPath":"/v2/pos/transactions"},{"label":"Retrieves a POS transaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/pos-transactions/flute-v2-get-pos-transactions-postransactionid","routeSlug":"/api-reference/v2/pos-transactions/flute-v2-get-pos-transactions-postransactionid","metadata":{"seo":{"title":"Retrieves a POS transaction by ID","description":"GET {{baseURL}}/v2/pos/transactions/{{posTransactionId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-pos-transactions-posTransactionId","name":"Retrieves a POS transaction by ID","isWebhook":false,"pointer":"/paths/~1v2~1pos~1transactions~1{posTransactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a POS transaction by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-pos-transactions-posTransactionId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/pos/transactions/{{posTransactionId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a POS transaction by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list POS transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/pos/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new POS transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/pos/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To cancel a POS transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/pos/transactions/{posTransactionId}/cancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"posTransactionId","in":"path","schemaId":"schema_214","description":"Specifies the POS transaction identifier.\n","required":true}],"pointer":"/paths/~1v2~1pos~1transactions~1{posTransactionId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"waitForTransactionProcessing","in":"query","schemaId":"schema_215","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the long poll for the transaction to reach a completed status before responding."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This could be success, failure, or cancellation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response is held until completion or timeout."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response returns immediately."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /pos/transactions/{{posTransactionId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be called for updates."},"children":[]}]}]}],"example":false}],"pointer":"/paths/~1v2~1pos~1transactions~1{posTransactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/pos/transactions/{posTransactionId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"posTransactionId","in":"path","required":true,"example":"361c152f-72fa-4654-84f1-a664584ce3de","schemaId":"schema_214"}],"query":[{"name":"waitForTransactionProcessing","in":"query","example":false,"schemaId":"schema_215"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","429","500"],"pointer":"/v2/pos/transactions/{posTransactionId}","href":"pos-transactions/flute-v2-get-pos-transactions-postransactionid","openApiOperationId":"flute-v2-get-pos-transactions-posTransactionId","summary":"Retrieves a POS transaction by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPosTransactionResponseDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetPosTransactionResponseDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/401/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/402/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetPosTransactionResponseDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetPosTransactionResponseDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/401/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pos-transactions/flute-v2-get-pos-transactions-postransactionid"}],"panels":[]}]},"httpPath":"/v2/pos/transactions/{posTransactionId}"},{"label":"Cancels a POS transaction by ID","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/pos-transactions/flute-v2-post-pos-transactions-postransactionid-cancel","routeSlug":"/api-reference/v2/pos-transactions/flute-v2-post-pos-transactions-postransactionid-cancel","metadata":{"seo":{"title":"Cancels a POS transaction by ID","description":"POST {{baseURL}}/v2/pos/transactions/{{posTransactionId}}/cancel"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-pos-transactions-posTransactionId-cancel","name":"Cancels a POS transaction by ID","isWebhook":false,"pointer":"/paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancels a POS transaction by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-pos-transactions-posTransactionId-cancel"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/pos/transactions/{{posTransactionId}}/cancel"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint cancels a POS transaction by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This sends a cancellation signal to the gateway to abort an in-progress POS transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It can only be called while the transaction is in a cancellable state."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is typically before the customer has presented their card on the terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cancellation request is not guaranteed if the terminal has already begun processing the payment."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In that case the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"posTransactionStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reflects the actual terminal outcome."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list POS transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/pos/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a POS transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/pos/transactions/{posTransactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a POS transaction reversal, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/pos/transactions/reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To print a receipt for a POS transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/pos/transactions/{posTransactionId}/print-receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"posTransactionId","in":"path","schemaId":"schema_216","description":"Specifies the POS transaction identifier to cancel.\n","required":true}],"pointer":"/paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/pos/transactions/{posTransactionId}/cancel","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"posTransactionId","in":"path","required":true,"example":"bc037464-05f0-4cc6-b1d9-66d44636a1a1","schemaId":"schema_216"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","409","429","500"],"pointer":"/v2/pos/transactions/{posTransactionId}/cancel","href":"pos-transactions/flute-v2-post-pos-transactions-postransactionid-cancel","openApiOperationId":"flute-v2-post-pos-transactions-posTransactionId-cancel","summary":"Cancels a POS transaction by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePosTransactionResponseDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreatePosTransactionResponseDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/401/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/402/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreatePosTransactionResponseDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreatePosTransactionResponseDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/401/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pos-transactions/flute-v2-post-pos-transactions-postransactionid-cancel"}],"panels":[]}]},"httpPath":"/v2/pos/transactions/{posTransactionId}/cancel"},{"label":"Prints a POS transaction receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/pos-transactions/flute-v2-post-pos-transactions-postransactionid-print-receipt","routeSlug":"/api-reference/v2/pos-transactions/flute-v2-post-pos-transactions-postransactionid-print-receipt","metadata":{"seo":{"title":"Prints a POS transaction receipt","description":"POST {{baseURL}}/v2/pos/transactions/{{posTransactionId}}/print-receipt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-pos-transactions-posTransactionId-print-receipt","name":"Prints a POS transaction receipt","isWebhook":false,"pointer":"/paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prints a POS transaction receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-pos-transactions-posTransactionId-print-receipt"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/pos/transactions/{{posTransactionId}}/print-receipt"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint prints a POS transaction receipt."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal must be in semi-integrated mode and available (online and ready)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A semi-integrated terminal is one that is connected to a POS system, typically through a network or cable."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list POS transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/pos/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a POS transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/pos/transactions/{posTransactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new POS transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/pos/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To cancel a POS transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/pos/transactions/{posTransactionId}/cancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"posTransactionId","in":"path","schemaId":"schema_217","description":"Specifies the POS transaction identifier whose receipt should be printed.\n","required":true}],"pointer":"/paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PrintTransactionReceiptRequestDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PrintTransactionReceiptRequestDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/pos/transactions/{posTransactionId}/print-receipt","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"posTransactionId","in":"path","required":true,"example":"6b486f55-e922-4a34-90c0-c78c75055eb1","schemaId":"schema_217"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PrintTransactionReceiptRequestDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/pos/transactions/{posTransactionId}/print-receipt","href":"pos-transactions/flute-v2-post-pos-transactions-postransactionid-print-receipt","openApiOperationId":"flute-v2-post-pos-transactions-posTransactionId-print-receipt","summary":"Prints a POS transaction receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/PrintTransactionReceiptRequestDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PrintTransactionReceiptRequestDto","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pos-transactions/flute-v2-post-pos-transactions-postransactionid-print-receipt"}],"panels":[]}]},"httpPath":"/v2/pos/transactions/{posTransactionId}/print-receipt"}],"content":{"contentType":"group","meta":{"name":"POS Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"POS Transactions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"payment-pos-transactions-overview"}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POS (point of sales) transactions represent payment transactions that are initiated and driven directly on a physical terminal device."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is in contrast to transactions created purely through an API, such as a card-not-present charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A POS transaction is the record of a payment flow that runs through a physical terminal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The point of service, such as a diner's table, creates it and enters at the terminal what to charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction can then be polled or listed to see the resulting status and the core transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The typical lifecycle that includes a POS transaction:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating one"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/pos/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This initiates a transaction on a specific terminal device with predefined details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These include the amount, transaction type, such as sale or authorization, currency, customer, pricing type, and whether to wait for the terminal to accept it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal handles the actual card read (readingMethod) and cardholder interaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking status"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A POS transaction has its own lifecycle status (posTransactionStatus)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is such as TransactionProcessing or Completed and is separate from the underlying core transactionId it eventually links to once processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listing them"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/pos/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This returns a paginated list of POS transactions, filterable by terminalId, showing fields like processedAmount, transactionType, and the linked transactionId."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/pos/transactions","summary":"Lists POS transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pos-transactions/flute-v2-get-pos-transactions","deprecated":false},{"title":"/v2/pos/transactions","summary":"Creates a POS transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pos-transactions/flute-v2-post-pos-transactions","deprecated":false},{"title":"/v2/pos/transactions/{posTransactionId}","summary":"Retrieves a POS transaction by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pos-transactions/flute-v2-get-pos-transactions-postransactionid","deprecated":false},{"title":"/v2/pos/transactions/{posTransactionId}/cancel","summary":"Cancels a POS transaction by ID","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pos-transactions/flute-v2-post-pos-transactions-postransactionid-cancel","deprecated":false},{"title":"/v2/pos/transactions/{posTransactionId}/print-receipt","summary":"Prints a POS transaction receipt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pos-transactions/flute-v2-post-pos-transactions-postransactionid-print-receipt","deprecated":false}]}]}]}]}},{"type":"group","label":"Settings","link":"/api-reference/v2/settings","routeSlug":"/api-reference/v2/settings","items":[{"label":"Lists payments configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/settings/flute-v2-get-settings-payment-config","routeSlug":"/api-reference/v2/settings/flute-v2-get-settings-payment-config","metadata":{"seo":{"title":"Lists payments configuration","description":"GET {{baseURL}}/v2/settings/payment-config"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-settings-payment-config","name":"Lists payments configuration","isWebhook":false,"pointer":"/paths/~1v2~1settings~1payment-config/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists payments configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-settings-payment-config"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/settings/payment-config"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists the payment configuration settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve the contact information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/settings/contact-information"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve the transaction autofill settings, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/settings/transaction-autofill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update the transaction autofill settings, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/settings/transaction-autofill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/settings/payment-config","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/settings/payment-config","href":"settings/flute-v2-get-settings-payment-config","openApiOperationId":"flute-v2-get-settings-payment-config","summary":"Lists payments configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentConfigurationResponseDto","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PaymentConfigurationResponseDto","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/403/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1settings~1payment-config/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentConfigurationResponseDto","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentConfigurationResponseDto","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1payment-config/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/flute-v2-get-settings-payment-config"}],"panels":[]}]},"httpPath":"/v2/settings/payment-config"},{"label":"Lists contact information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/settings/flute-v2-get-settings-contact-information","routeSlug":"/api-reference/v2/settings/flute-v2-get-settings-contact-information","metadata":{"seo":{"title":"Lists contact information","description":"GET {{baseURL}}/v2/settings/contact-information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-settings-contact-information","name":"Lists contact information","isWebhook":false,"pointer":"/paths/~1v2~1settings~1contact-information/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists contact information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-settings-contact-information"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/settings/contact-information"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists contact information for the merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve the payment configuration, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/settings/payment-config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve the transaction autofill settings, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/settings/transaction-autofill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update the transaction autofill settings, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/settings/transaction-autofill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/settings/contact-information","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/settings/contact-information","href":"settings/flute-v2-get-settings-contact-information","openApiOperationId":"flute-v2-get-settings-contact-information","summary":"Lists contact information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactInfoResponseDto","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ContactInfoResponseDto","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/403/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1settings~1contact-information/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContactInfoResponseDto","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContactInfoResponseDto","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1contact-information/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/flute-v2-get-settings-contact-information"}],"panels":[]}]},"httpPath":"/v2/settings/contact-information"},{"label":"Lists levels 2 and 3 autofill settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/settings/flute-v2-get-settings-transaction-autofill","routeSlug":"/api-reference/v2/settings/flute-v2-get-settings-transaction-autofill","metadata":{"seo":{"title":"Lists levels 2 and 3 autofill settings","description":"GET {{baseURL}}/v2/settings/transaction-autofill"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-settings-transaction-autofill","name":"Lists levels 2 and 3 autofill settings","isWebhook":false,"pointer":"/paths/~1v2~1settings~1transaction-autofill/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists levels 2 and 3 autofill settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-settings-transaction-autofill"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/settings/transaction-autofill"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists levels 2 and 3 autofill settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The additional levels 2 and 3 information must be included in transactions requiring that level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This information can be pre-configured at the merchant settings level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows merchants to automatically include the information instead of manually entering each time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This automatic inclusion is called autofill."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With autofill, a merchant configures defaults once."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To set the defaults and values, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/settings/transaction-autofill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Thereafter, Flute automatically appends those values to every transaction even if not included in the transaction request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a merchant selling the same product, such as a subscription service could set the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxRate: 8.5 for Level 2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product.code: SUB-001, product.unitPrice: 29.99 for Level 3"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every transaction then automatically includes that data, qualifying for lower interchange rates without any extra work per transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve the payment configuration, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/settings/payment-config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve the contact information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/settings/contact-information"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update the transaction autofill settings, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/settings/transaction-autofill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/settings/transaction-autofill","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/settings/transaction-autofill","href":"settings/flute-v2-get-settings-transaction-autofill","openApiOperationId":"flute-v2-get-settings-transaction-autofill","summary":"Lists levels 2 and 3 autofill settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionAutofillResponseDto","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/TransactionAutofillResponseDto","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/403/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1settings~1transaction-autofill/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransactionAutofillResponseDto","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionAutofillResponseDto","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/flute-v2-get-settings-transaction-autofill"}],"panels":[]}]},"httpPath":"/v2/settings/transaction-autofill"},{"label":"Updates levels 2 and 3 settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/settings/flute-v2-patch-settings-transaction-autofill","routeSlug":"/api-reference/v2/settings/flute-v2-patch-settings-transaction-autofill","metadata":{"seo":{"title":"Updates levels 2 and 3 settings","description":"PATCH {{baseURL}}/v2/settings/transaction-autofill"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-patch-settings-transaction-autofill","name":"Updates levels 2 and 3 settings","isWebhook":false,"pointer":"/paths/~1v2~1settings~1transaction-autofill/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates levels 2 and 3 settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-patch-settings-transaction-autofill"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PATCH {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/settings/transaction-autofill"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint updates or sets levels 2 and 3 autofill settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is a partial update."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send only the fields needed to be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An omitted field is left unchanged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A field marked with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" clears a field."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nested structures are also affected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The additional levels 2 and 3 information must be included in transactions requiring that level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This information can be pre-configured at the merchant settings level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows merchants to automatically include the information instead of manually entering each time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This automatic inclusion is called autofill."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With autofill, a merchant configures defaults once."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the existing set of defaults and values, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/settings/transaction-autofill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Thereafter, Flute automatically appends those values to every transaction even if not included in the transaction request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a merchant selling the same product, such as a subscription service could set the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"taxRate: 8.5 for Level 2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product.code: SUB-001, product.unitPrice: 29.99 for Level 3"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every transaction then automatically includes that data, qualifying for lower interchange rates without any extra work per transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve the payment configuration, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/settings/payment-config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve the contact information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/settings/contact-information"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve the transaction autofill settings, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/settings/transaction-autofill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTransactionAutofillRequestDto","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateTransactionAutofillRequestDto","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1settings~1transaction-autofill/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/settings/transaction-autofill","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTransactionAutofillRequestDto","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/settings/transaction-autofill","href":"settings/flute-v2-patch-settings-transaction-autofill","openApiOperationId":"flute-v2-patch-settings-transaction-autofill","summary":"Updates levels 2 and 3 settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/UpdateTransactionAutofillRequestDto","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTransactionAutofillRequestDto","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1settings~1transaction-autofill/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settings~1transaction-autofill/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/flute-v2-patch-settings-transaction-autofill"}],"panels":[]}]},"httpPath":"/v2/settings/transaction-autofill"}],"content":{"contentType":"group","meta":{"name":"Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settings","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"settings"}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint group lists the preset and default settings for payments, discounts, and premium charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Levels 2 and 3"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some settings list information about levels, specifically Levels 2 and 3."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Levels refer to data standards for credit card transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They provide increasingly detailed standards."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Higher data standards qualify for lower interchange rates from Visa and Mastercard."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means, merchants save on processing fees."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Advanced level are often required by many government and large enterprise buyers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This also accommodates buyers needing detailed transaction data for accounting and reconciliation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 1"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 1 is the most basic data standards for credit card transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In general industry terms, Level 1 is simply a standard transaction with basic data."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes the amount, date, merchant name, card number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's the default when no enhanced data is provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 2"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an enhanced data standard."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is typically the standard for business to business transactions, such as corporate, and purchasing cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 2 adds:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer code and purchase order number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A tax indicator."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a flag indicting if tax is included in the transaction amount, and if so, what kind."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 3"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the most advanced data standard."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It offers the most detail and accountability."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is typically the standard for large business to business transactions, government transactions, and government purchase cards."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 3 can reduce interchange fees by 0.5% to 1.5% compared to Level 1."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This discount become significant at high transaction volumes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 3 adds:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Line-item details, such as product codes, descriptions, quantities, unit prices"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ship-to and ship-from postal codes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Freight amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discount amount"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/settings/payment-config","summary":"Lists payments configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settings/flute-v2-get-settings-payment-config","deprecated":false},{"title":"/v2/settings/contact-information","summary":"Lists contact information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settings/flute-v2-get-settings-contact-information","deprecated":false},{"title":"/v2/settings/transaction-autofill","summary":"Lists levels 2 and 3 autofill settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settings/flute-v2-get-settings-transaction-autofill","deprecated":false},{"title":"/v2/settings/transaction-autofill","summary":"Updates levels 2 and 3 settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/settings/flute-v2-patch-settings-transaction-autofill","deprecated":false}]}]}]}]}},{"type":"group","label":"Settlements","link":"/api-reference/v2/settlements","routeSlug":"/api-reference/v2/settlements","items":[{"label":"Lists transaction batch settlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/settlements/flute-v2-get-settlements-batches","routeSlug":"/api-reference/v2/settlements/flute-v2-get-settlements-batches","metadata":{"seo":{"title":"Lists transaction batch settlements","description":"GET {{baseURL}}/v2/settlements/batches"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-settlements-batches","name":"Lists transaction batch settlements","isWebhook":false,"pointer":"/paths/~1v2~1settlements~1batches/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists transaction batch settlements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-settlements-batches"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/settlements/batches"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists transaction batch settlements."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To settle transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/settlements/settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageIndex","in":"query","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the page number of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value restrictions include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value less than zero is not permitted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values equal to or greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end successfully but will not return any items."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page size information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 0"},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of items for each page of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page numbering information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 50"},"children":[]}]}]}]},{"name":"asc","in":"query","schemaId":"schema_192","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sort order is ascending."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort field is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the sort order is ascending."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the sort order is descending."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_193","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the field the results get ordered or sorted by."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort order is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field that gets sorted by is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"example":"ContactName"},{"name":"dateFrom","in":"query","schemaId":"schema_211","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters returning items on or after this date (in an ISO 8601 date-time format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to the present."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an inclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an explicit range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"dateTo","in":"query","schemaId":"schema_212","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters returning items on or to this date (in an ISO 8601 date-time format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items before including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an inclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an explicit range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"batchIds","in":"query","schemaId":"schema_218","description":"Filters by with an array of specified batch identifiers.\n"},{"name":"paymentProcessorIds","in":"query","schemaId":"schema_219","description":"Filters by an array of specified payment processor identifiers.\n"},{"name":"status","in":"query","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the batch settlement type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An open batch is still active and accepting transactions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A settled batch has completed processing with the acquirer or bank."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Open"},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1settlements~1batches/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/settlements/batches","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"pageIndex","in":"query","schemaId":"schema_190"},{"name":"pageSize","in":"query","schemaId":"schema_191"},{"name":"asc","in":"query","schemaId":"schema_192"},{"name":"sortBy","in":"query","example":"ContactName","schemaId":"schema_193"},{"name":"dateFrom","in":"query","example":"2025-01-27T12:05:54.322Z","schemaId":"schema_211"},{"name":"dateTo","in":"query","example":"2026-02-27T12:05:54.322Z","schemaId":"schema_212"},{"name":"batchIds","in":"query","example":["fe08c47b-2c3d-4e4f-5a6b-7c8d9e0f1a47","0f19d58c-3d4e-4f5a-6b7c-8d9e0f1a2b58"],"schemaId":"schema_218"},{"name":"paymentProcessorIds","in":"query","schemaId":"schema_219"},{"name":"status","in":"query","required":false,"example":"Open","schemaId":"schema_220"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/settlements/batches","href":"settlements/flute-v2-get-settlements-batches","openApiOperationId":"flute-v2-get-settlements-batches","summary":"Lists transaction batch settlements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfListBatchesResponseDto","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PageOfListBatchesResponseDto","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/403/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1settlements~1batches/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfListBatchesResponseDto","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfListBatchesResponseDto","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1batches/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/flute-v2-get-settlements-batches"}],"panels":[]}]},"httpPath":"/v2/settlements/batches"},{"label":"Settles transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/settlements/flute-v2-post-settlements-settle","routeSlug":"/api-reference/v2/settlements/flute-v2-post-settlements-settle","metadata":{"seo":{"title":"Settles transactions","description":"POST {{baseURL}}/v2/settlements/settle"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-settlements-settle","name":"Settles transactions","isWebhook":false,"pointer":"/paths/~1v2~1settlements~1settle/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settles transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-settlements-settle"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/settlements/settle"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint explicitly settles batched transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list settlement batches, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/settlements/batches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SettleTransactionsRequestDto","exampleIds":["paths/~1v2~1settlements~1settle/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SettleTransactionsRequestDto","exampleIds":["paths/~1v2~1settlements~1settle/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1settlements~1settle/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/settlements/settle","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SettleTransactionsRequestDto","exampleIds":["paths/~1v2~1settlements~1settle/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","402","403","404","409","429","500"],"pointer":"/v2/settlements/settle","href":"settlements/flute-v2-post-settlements-settle","openApiOperationId":"flute-v2-post-settlements-settle","summary":"Settles transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/SettleTransactionsRequestDto","exampleIds":["paths/~1v2~1settlements~1settle/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SettleTransactionsRequestDto","exampleIds":["paths/~1v2~1settlements~1settle/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SettleTransactionsResponseDto","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SettleTransactionsResponseDto","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/401/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/402/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1settlements~1settle/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SettleTransactionsResponseDto","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SettleTransactionsResponseDto","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/401/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1settlements~1settle/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/flute-v2-post-settlements-settle"}],"panels":[]}]},"httpPath":"/v2/settlements/settle"}],"content":{"contentType":"group","meta":{"name":"Settlements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settlements","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"settlements"}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement is the process of actually transferring funds between parties to finalize a transaction"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is different from authorization, which just reserves or confirms funds are available."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means funds are not instantly available for each transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchants may see a delay between a sale and the funds deposited in their account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The typical lifecycle that includes settlement:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An authorized transaction is one that has been approved and funds are held or reserved."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No money has moved yet."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the following call starts a transaction with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"captureMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This automatically adds the transaction in an open settlement batch when the transaction is completed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The call returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which may be used to reference this transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Sample Authorization Call"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"id":"sample-authorization-call"}},"children":[]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  POST /v2/transactions\n  Authorization: Bearer {{apiKey}}                                                                                          \n  Content-Type: application/json\n  {                                                                                                                         \n  \"baseAmount\": 150.00,                                                                                                 \n  \"currencyCode\": \"USD\",\n  \"customerInitiatedTransaction\": true,\n      \"transactionDetails\": \n      {\n          \"cardData\":\n          {\n              \"captureMethod\": \"Auto\",\n              \"paymentMethodDetails\":\n              {\n                \"cardNumber\": \"4111111111111111\",\n                \"securityCode\": \"737\",\n                \"expirationMonth\": 9,\n                \"expirationYear\": 2027\n                }\n            }\n        }\n    }\n","language":"csharp"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  POST /v2/transactions\n  Authorization: Bearer {{apiKey}}                                                                                          \n  Content-Type: application/json\n  {                                                                                                                         \n  \"baseAmount\": 150.00,                                                                                                 \n  \"currencyCode\": \"USD\",\n  \"customerInitiatedTransaction\": true,\n      \"transactionDetails\": \n      {\n          \"cardData\":\n          {\n              \"captureMethod\": \"Auto\",\n              \"paymentMethodDetails\":\n              {\n                \"cardNumber\": \"4111111111111111\",\n                \"securityCode\": \"737\",\n                \"expirationMonth\": 9,\n                \"expirationYear\": 2027\n                }\n            }\n        }\n    }\n"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capture or batch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Approved transactions are grouped together, or batched, for later processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"captureMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", no additional processing is required at this step."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction has been added to the settlement batch automatically."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"captureMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the transaction must be explicitly added to the settlement batch."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In this case use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{{transactionId}}/capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to capture it to the settlement batch."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken when using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" because if the transaction is never captured, the authorization simply expires and no funds move."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"details","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"summary","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Sample Capture Call"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"id":"sample-capture-call"}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit the body (or send {}) for a full capture. Once captured, it enters the open settlement batch."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"POST /v2/transactions/{{transactionId}}/capture\nAuthorization: Bearer {{apiKey}}\nContent-Type: application/json\n\n{\n  \"amount\": 150.00\n}\n","language":"csharp"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"POST /v2/transactions/{{transactionId}}/capture\nAuthorization: Bearer {{apiKey}}\nContent-Type: application/json\n\n{\n  \"amount\": 150.00\n}\n"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Settlement is the step where an authorized transaction becomes a real transfer of money."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch is submitted to the card networks or banks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This processing includes moving the money from the cardholder's bank, through the network, to the acquiring bank."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It eventually ends at merchant's account, minus fees."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/settlements/settle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to initiate the settlement batch."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This batch processing usually happens on a schedule, such as daily batch settlement at the end of business."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/settlements/batches","summary":"Lists transaction batch settlements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/flute-v2-get-settlements-batches","deprecated":false},{"title":"/v2/settlements/settle","summary":"Settles transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settlements/flute-v2-post-settlements-settle","deprecated":false}]}]}]}]}},{"type":"group","label":"Terminals","link":"/api-reference/v2/terminals","routeSlug":"/api-reference/v2/terminals","items":[{"label":"Lists merchant's terminals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/terminals/flute-v2-get-terminals","routeSlug":"/api-reference/v2/terminals/flute-v2-get-terminals","metadata":{"seo":{"title":"Lists merchant's terminals","description":"GET {{baseURL}}/v2/terminals"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-terminals","name":"Lists merchant's terminals","isWebhook":false,"pointer":"/paths/~1v2~1terminals/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists merchant's terminals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-terminals"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/terminals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists all available terminals for the authenticated merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only active terminals are returned."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminals in the following conditions are excluded:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pre-activation states, such as pending shipment or in transit"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivated terminals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a terminal's status by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/terminals/{terminalId}/status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageIndex","in":"query","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the page number of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value restrictions include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value less than zero is not permitted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values equal to or greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end successfully but will not return any items."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page size information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 0"},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of items for each page of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page numbering information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 50"},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a field name to sort the results by."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null or omitted, results come back newest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminalManufacturer"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchantCompanyName"},"children":[]}]}]}]},{"name":"sortOrder","in":"query","schemaId":"schema_209","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sort order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort order is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field that gets sorted by is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"asc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results from the lowest value to the highest value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"desc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results from the highest value to the lowest value."},"children":[]}]}]}]}]}]}],"example":"desc"},{"name":"terminalStatus","in":"query","schemaId":"schema_222","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the availability status of the terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Busy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal is processing a transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ready"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal is available for a new transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offline"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal is unavailable for a new transaction."},"children":[]}]}]}]}]}]}],"example":"Ready"},{"name":"terminalMode","in":"query","schemaId":"schema_223","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the operating mode of the terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mode"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal operates independently of any POS system."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount is entered directly on the terminal itself (no electronic connection to a cash register/POS software), and it runs the transaction on its own."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SemiIntegrated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal is connected to a POS system, typically through a network or cable."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POS sends the transaction amount to the terminal electronically, rather than requiring manual entry. However, the POS never touches card or payment data directly. The terminal handles all sensitive payment processing itself. This architecture is commonly used to reduce PCI compliance scope on the POS side."},"children":[]}]}]}]}]}]}]},{"name":"connectionStatus","in":"query","schemaId":"schema_224","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the line status of the terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Online"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal is currently connected and reachable."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It has active network or internet connectivity. It is able to process transactions and communicate with the backend in real time."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offline"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal is disconnected or unreachable."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It may be powered off, have lost its network connection, or otherwise be unable to communicate. As a result, it cannot process transactions, or can only do so in a stored or deferred mode depending on the platform."},"children":[]}]}]}]}]}]}],"example":"Online"},{"name":"serialNumber","in":"query","schemaId":"schema_225","description":"Filters by the serial number.\n\nThis is an exact match search.\n","example":"SN100001"},{"name":"search","in":"query","schemaId":"schema_226","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters using a search string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This performs a case-insensitive search that matches exactly or partially."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field does not have to be specified."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the results are to be sorted, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the sort field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The search includes the following fields:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"serialNumber"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminalModel"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminalManufacturer"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminalId"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchantCompanyName"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peppared Street Cafe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Street"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ree"},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1terminals/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/terminals","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"pageIndex","in":"query","schemaId":"schema_190"},{"name":"pageSize","in":"query","schemaId":"schema_191"},{"name":"sortBy","in":"query","example":"terminalManufacturer","schemaId":"schema_221"},{"name":"sortOrder","in":"query","example":"desc","schemaId":"schema_209"},{"name":"terminalStatus","in":"query","example":"Ready","schemaId":"schema_222"},{"name":"terminalMode","in":"query","example":"SemiIntegrated","schemaId":"schema_223"},{"name":"connectionStatus","in":"query","example":"Online","schemaId":"schema_224"},{"name":"serialNumber","in":"query","example":"SN100001","schemaId":"schema_225"},{"name":"search","in":"query","example":"Peppared Street Cafe","schemaId":"schema_226"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/terminals","href":"terminals/flute-v2-get-terminals","openApiOperationId":"flute-v2-get-terminals","summary":"Lists merchant's terminals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfListTerminalsResponseDto","exampleIds":["paths/~1v2~1terminals/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PageOfListTerminalsResponseDto","exampleIds":["paths/~1v2~1terminals/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/403/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1terminals/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfListTerminalsResponseDto","exampleIds":["paths/~1v2~1terminals/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfListTerminalsResponseDto","exampleIds":["paths/~1v2~1terminals/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/terminals/flute-v2-get-terminals"}],"panels":[]}]},"httpPath":"/v2/terminals"},{"label":"Retrieves a merchant's terminal POS status by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/terminals/flute-v2-get-terminals-terminalid-status","routeSlug":"/api-reference/v2/terminals/flute-v2-get-terminals-terminalid-status","metadata":{"seo":{"title":"Retrieves a merchant's terminal POS status by ID","description":"GET {{baseURL}}/v2/terminals/{{terminalId}}/status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-terminals-terminalId-status","name":"Retrieves a merchant's terminal POS status by ID","isWebhook":false,"pointer":"/paths/~1v2~1terminals~1{terminalId}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a merchant's terminal POS status by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-terminals-terminalId-status"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/terminals/{{terminalId}}/status"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint Retrieves a merchant's terminal POS status by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"information includes the connection and network state, hardware info and software version."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This provides the latest available information about a terminal, updated in near real-time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint before initiating a POS transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It verifies the terminal is reachable and ready to accept a payment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before creating a POS transaction, check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"terminalStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Ready"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Busy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Offline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batteryLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and p"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rinterStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used to warn merchants of low battery or printer issues before starting a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Depending on the terminal's internet connectivity and operational status, the response may include limited terminal data."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"terminalId","in":"path","schemaId":"schema_227","description":"Specifies the terminal identifier.\n","required":true}],"pointer":"/paths/~1v2~1terminals~1{terminalId}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/terminals/{terminalId}/status","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"terminalId","in":"path","required":true,"example":"ad307589-17b9-4f8a-9489-6b4c48f0c40d","schemaId":"schema_227"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v2/terminals/{terminalId}/status","href":"terminals/flute-v2-get-terminals-terminalid-status","openApiOperationId":"flute-v2-get-terminals-terminalId-status","summary":"Retrieves a merchant's terminal POS status by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTerminalStatusResponseDto","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetTerminalStatusResponseDto","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1terminals~1{terminalId}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetTerminalStatusResponseDto","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTerminalStatusResponseDto","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1terminals~1{terminalId}~1status/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/terminals/flute-v2-get-terminals-terminalid-status"}],"panels":[]}]},"httpPath":"/v2/terminals/{terminalId}/status"}],"content":{"contentType":"group","meta":{"name":"Terminals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Terminals","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"terminals"}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A terminal represents a physical payment device deployed to a merchant to accept card and other electronic payments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each terminal is tracked from the point it's ordered through its active use in the field, including hardware details, connectivity, and security provisioning."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The combination of all the details and attributes portrays and monitors a terminal's readiness, connectivity, and security posture throughout its deployment."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/terminals","summary":"Lists merchant's terminals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/terminals/flute-v2-get-terminals","deprecated":false},{"title":"/v2/terminals/{terminalId}/status","summary":"Retrieves a merchant's terminal POS status by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/terminals/flute-v2-get-terminals-terminalid-status","deprecated":false}]}]}]}]}},{"type":"group","label":"Transactions","link":"/api-reference/v2/transactions","routeSlug":"/api-reference/v2/transactions","items":[{"label":"Lists transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/transactions/flute-v2-get-transactions","routeSlug":"/api-reference/v2/transactions/flute-v2-get-transactions","metadata":{"seo":{"title":"Lists transactions","description":"GET {{baseURL}}/v2/transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-transactions","name":"Lists transactions","isWebhook":false,"pointer":"/paths/~1v2~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-transactions"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items returned here present a limited amount of details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These are intended to be a brief summary of the transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For complete details of a specific transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions/{transactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions/{transactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To capture a transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageIndex","in":"query","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the page number of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value restrictions include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value less than zero is not permitted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values equal to or greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end successfully but will not return any items."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page size information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 0"},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of items for each page of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page numbering information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 50"},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_228","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a field name to sort the results by."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null or omitted, results come back newest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cardTokenType"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customerCompanyName"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customerName"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"maskedCardNumber"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchantCompanyName"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"paymentMethodType"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"processedAmount"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionDateTime"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionId"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactionStatus"},"children":[]}]}]}]},{"name":"sortOrder","in":"query","schemaId":"schema_209","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sort order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort order is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field that gets sorted by is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"asc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results from the lowest value to the highest value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"desc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results from the highest value to the lowest value."},"children":[]}]}]}]}]}]}],"example":"desc"},{"name":"fromDate","in":"query","schemaId":"schema_211","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a filter to return items created on or after this date (in an ISO 8601 date-time format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to the present."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an exclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an exclusive range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"toDate","in":"query","schemaId":"schema_212","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a filter to return items created on or to this date (in an ISO 8601 date-time format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items up to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an exclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an explicit range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"sourceType","in":"query","schemaId":"schema_229","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a filter by the transaction source."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ApiKey"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external application created the transaction using an API key."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A billed invoice created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MobileApp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A mobile application created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A staff member created the transaction through the web portal."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QuickPayment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A one-time payment link created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A recurring subscription created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TapToPay"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A mobile device using tap to pay created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A physical payment terminal created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WebComponent"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An embedded web component created the transaction."},"children":[]}]}]}]}]}]}],"example":"ApiKey"},{"name":"sourceId","in":"query","schemaId":"schema_230","description":"Specifies a filter by the source identifier.\n"},{"name":"batchId","in":"query","schemaId":"schema_231","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a filter by the settlement batch identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return transactions not yet settled into a batch."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit this value to not filter by batch identifier."},"children":[]}]}]}],"example":"0b7aa955-6b52-4dcb-b0d8-7c3d82f27b62"},{"name":"transactionStatus","in":"query","schemaId":"schema_232","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a filter by the aggregated transaction status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment approved but funds not yet captured."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction stopped before it completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Captured"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved funds collected from the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ChargedBack"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder disputed the charge with their bank."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cleared"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds finished processing and settled."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment rejected by the bank or processor."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card/ACH"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction could not complete due to an error."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card/ACH"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Held"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction paused and awaiting release."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HeldByProcessor"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processor paused the transaction for review."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informational"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Record used for reference only, not a live charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InProgress"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction is still processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PartiallyAuthorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only part of the requested amount was approved."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction is waiting for a result."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card/ACH"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds returned to the cardholder."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction set to run at a future time."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds moved from issuer to the merchant account."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card or account confirmed as valid."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization cancelled before capture."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]}]}]}]}]},{"name":"paymentMethodType","in":"query","schemaId":"schema_233","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a filter by the payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment made through an ACH bank transfer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment made with a credit or debit card."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment made with physical currency."},"children":[]}]}]}]}]}]}],"example":"Card"},{"name":"customerId","in":"query","schemaId":"schema_234","description":"Specifies a filter by the customer identifier.\n"},{"name":"merchantId","in":"query","schemaId":"schema_235","description":"Specifies a filter by the merchant identifier.\n"},{"name":"minAmount","in":"query","schemaId":"schema_236","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a filter by the minimum transaction amount to include in the results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only transactions with this amount or more are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all transactions with at least this amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an exclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an inclusive range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"maxAmount","in":"query","schemaId":"schema_236","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a filter by the maximum transaction amount to include in the results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only transactions with this amount or less are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all transactions with no more than this amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"minAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an exclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an inclusive range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"referenceId","in":"query","schemaId":"schema_237","description":"Specifies a filter by the reference identifier provided by the merchant.\n\nA referenceId is a duplicate-check key.\nIt allows the same card and amount combination to be charged multiple times when the reference identifiers are different.\n"}],"pointer":"/paths/~1v2~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/transactions","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"pageIndex","in":"query","schemaId":"schema_190"},{"name":"pageSize","in":"query","schemaId":"schema_191"},{"name":"sortBy","in":"query","example":"transactionDateTime","schemaId":"schema_228"},{"name":"sortOrder","in":"query","example":"desc","schemaId":"schema_209"},{"name":"fromDate","in":"query","example":"2025-01-27T12:05:54.322Z","schemaId":"schema_211"},{"name":"toDate","in":"query","example":"2026-02-27T12:05:54.322Z","schemaId":"schema_212"},{"name":"sourceType","in":"query","example":"ApiKey","schemaId":"schema_229"},{"name":"sourceId","in":"query","example":"81915d04-1f2a-4b3c-4d5e-6f7a8b9c0d36","schemaId":"schema_230"},{"name":"batchId","in":"query","example":"0b7aa955-6b52-4dcb-b0d8-7c3d82f27b62","schemaId":"schema_231"},{"name":"transactionStatus","in":"query","example":"Authorized","schemaId":"schema_232"},{"name":"paymentMethodType","in":"query","example":"Card","schemaId":"schema_233"},{"name":"customerId","in":"query","example":"8fa8e727-73c6-436e-b56f-6f55aabf3b1c","schemaId":"schema_234"},{"name":"merchantId","in":"query","example":"92a26e15-2a3b-4c4d-5e6f-7a8b9c0d1e47","schemaId":"schema_235"},{"name":"minAmount","in":"query","example":500,"schemaId":"schema_236"},{"name":"maxAmount","in":"query","example":500,"schemaId":"schema_236"},{"name":"referenceId","in":"query","example":"REF-EXT-12345","schemaId":"schema_237"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/transactions","href":"transactions/flute-v2-get-transactions","openApiOperationId":"flute-v2-get-transactions","summary":"Lists transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/403/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/flute-v2-get-transactions"}],"panels":[]}]},"httpPath":"/v2/transactions"},{"label":"Creates a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/transactions/flute-v2-post-transactions","routeSlug":"/api-reference/v2/transactions/flute-v2-post-transactions","metadata":{"seo":{"title":"Creates a transaction","description":"POST {{baseURL}}/v2/transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-transactions","name":"Creates a transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-transactions"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint creates a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To capture a transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To calculate a transaction amount, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/calculate-amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".`"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTransactionRequestDto","exampleIds":["paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — saved payment method","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — new card","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — saved payment method","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — new account"]}},"schemaId":"components/schemas/CreateTransactionRequestDto","exampleIds":["paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — saved payment method","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — new card","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — saved payment method","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — new account"],"pointer":"/paths/~1v2~1transactions/post/requestBody","description":"Transaction request with payment method and transaction type"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTransactionRequestDto","exampleIds":["paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — saved payment method","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — new card","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — saved payment method","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — new account"]}},"responseCodes":["200","400","401","402","403","404","409","429","500"],"pointer":"/v2/transactions","href":"transactions/flute-v2-post-transactions","openApiOperationId":"flute-v2-post-transactions","summary":"Creates a transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/CreateTransactionRequestDto","exampleIds":["paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — saved payment method","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — new card","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — saved payment method","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — new account"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTransactionRequestDto","exampleIds":["paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — saved payment method","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — new card","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — saved payment method","paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — new account"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (Authorization)","paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (Sale)","paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (ACH)"]}},"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (Authorization)","paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (Sale)","paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (ACH)"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/401/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/402/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1transactions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (Authorization)","paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (Sale)","paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (ACH)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (Authorization)","paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (Sale)","paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (ACH)"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/401/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/flute-v2-post-transactions"}],"panels":[]}]},"httpPath":"/v2/transactions"},{"label":"Retrieves a transaction by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/transactions/flute-v2-get-transactions-transactionid","routeSlug":"/api-reference/v2/transactions/flute-v2-get-transactions-transactionid","metadata":{"seo":{"title":"Retrieves a transaction by ID","description":"GET {{baseURL}}/v2/transactions/{{transactionId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-transactions-transactionId","name":"Retrieves a transaction by ID","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a transaction by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-transactions-transactionId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/transactions/{{transactionId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a transaction by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To capture a transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transactionId","in":"path","schemaId":"schema_238","description":"Specifies the transaction identifier.\n","required":true}],"pointer":"/paths/~1v2~1transactions~1{transactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/transactions/{transactionId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"transactionId","in":"path","required":true,"example":"3c25d7e4-dfe0-4ede-a3f0-fb280cac281c","schemaId":"schema_238"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/v2/transactions/{transactionId}","href":"transactions/flute-v2-get-transactions-transactionid","openApiOperationId":"flute-v2-get-transactions-transactionId","summary":"Retrieves a transaction by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTransactionResponseDtoFull","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/200/content/application~1json/examples/Card transaction (Completed)","paths/~1v2~1transactions~1{transactionId}/get/responses/200/content/application~1json/examples/ACH transaction (Completed)"]}},"schemaId":"components/schemas/GetTransactionResponseDtoFull","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/200/content/application~1json/examples/Card transaction (Completed)","paths/~1v2~1transactions~1{transactionId}/get/responses/200/content/application~1json/examples/ACH transaction (Completed)"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1transactions~1{transactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetTransactionResponseDtoFull","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/200/content/application~1json/examples/Card transaction (Completed)","paths/~1v2~1transactions~1{transactionId}/get/responses/200/content/application~1json/examples/ACH transaction (Completed)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTransactionResponseDtoFull","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/200/content/application~1json/examples/Card transaction (Completed)","paths/~1v2~1transactions~1{transactionId}/get/responses/200/content/application~1json/examples/ACH transaction (Completed)"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/flute-v2-get-transactions-transactionid"}],"panels":[]}]},"httpPath":"/v2/transactions/{transactionId}"},{"label":"Captures a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/transactions/flute-v2-post-transactions-transactionid-capture","routeSlug":"/api-reference/v2/transactions/flute-v2-post-transactions-transactionid-capture","metadata":{"seo":{"title":"Captures a transaction","description":"POST {{baseURL}}/v2/transactions/{{transactionId}}/capture"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-transactions-transactionId-capture","name":"Captures a transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transactionId}~1capture/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Captures a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-transactions-transactionId-capture"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/transactions/{{transactionId}}/capture"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint captures a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This captures a previously authorized transaction and settling it for the specified amount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is used when a transaction was created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"captureMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows merchants to delay settlement until fulfillment is confirmed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"captureAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be less than or equal to the original authorized amount to support partial captures."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If successful, this returns the full transaction object reflecting the updated status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A processor declining the transaction returns a 402 error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions/{transactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transactionId","in":"path","schemaId":"schema_239","description":"Specifies the transaction identifier.\n","required":true}],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1capture/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaptureRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CaptureRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1capture/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies an object defining the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the request body is null or omitted, a full capture is included."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"baseAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included, a partial capture is made."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transactionId}/capture","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"transactionId","in":"path","required":true,"example":"487471b7-0149-44ed-840b-97d920e06829","schemaId":"schema_239"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CaptureRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","402","403","404","409","429","500"],"pointer":"/v2/transactions/{transactionId}/capture","href":"transactions/flute-v2-post-transactions-transactionid-capture","openApiOperationId":"flute-v2-post-transactions-transactionId-capture","summary":"Captures a transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/CaptureRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CaptureRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/401/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/402/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1capture/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/401/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/flute-v2-post-transactions-transactionid-capture"}],"panels":[]}]},"httpPath":"/v2/transactions/{transactionId}/capture"},{"label":"Reverses a transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/transactions/flute-v2-post-transactions-transactionid-reversal","routeSlug":"/api-reference/v2/transactions/flute-v2-post-transactions-transactionid-reversal","metadata":{"seo":{"title":"Reverses a transaction","description":"POST {{baseURL}}/v2/transactions/{{transactionId}}/reversal"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-transactions-transactionId-reversal","name":"Reverses a transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transactionId}~1reversal/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reverses a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-transactions-transactionId-reversal"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/transactions/{{transactionId}}/reversal"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint reverses, or refunds, a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method (card vs ACH) is auto-detected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions/{transactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To capture a transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create an unreferenced credit, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transactionId","in":"path","schemaId":"schema_240","description":"Specifies the transaction identifier to refund.\n","required":true}],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1reversal/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReversalRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ReversalRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1reversal/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reversal options including optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a partial refund."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transactionId}/reversal","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"transactionId","in":"path","required":true,"example":"d4e39f93-a128-45f4-9b27-140042a5efa5","schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReversalRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","402","403","404","409","429","500"],"pointer":"/v2/transactions/{transactionId}/reversal","href":"transactions/flute-v2-post-transactions-transactionid-reversal","openApiOperationId":"flute-v2-post-transactions-transactionId-reversal","summary":"Reverses a transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/ReversalRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReversalRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/401/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/402/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/401/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/flute-v2-post-transactions-transactionid-reversal"}],"panels":[]}]},"httpPath":"/v2/transactions/{transactionId}/reversal"},{"label":"Credits from a transaction without reference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/transactions/flute-v2-post-transactions-credit","routeSlug":"/api-reference/v2/transactions/flute-v2-post-transactions-credit","metadata":{"seo":{"title":"Credits from a transaction without reference","description":"POST {{baseURL}}/v2/transactions/credit"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-transactions-credit","name":"Credits from a transaction without reference","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1credit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credits from a transaction without reference","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-transactions-credit"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/transactions/credit"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint refunds or returns funds without a reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes refunding to a credit card or provides an ACH credit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without a reference means the customer does not have the link to the original transaction identifier."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This creates a refund transaction that is not linked to a specific previous transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instead of refunding a known transaction identifier, the system processes a standalone credit back to the cardholder's payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As a warning, these are considered high-risk transaction types."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds are returned directly from the merchant's account even if the original sale was not processed through Flute."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions/{transactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditRequestDto","exampleIds":["paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/Card unreferenced refund","paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/ACH credit"]}},"schemaId":"components/schemas/CreditRequestDto","exampleIds":["paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/Card unreferenced refund","paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/ACH credit"],"pointer":"/paths/~1v2~1transactions~1credit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/credit","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditRequestDto","exampleIds":["paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/Card unreferenced refund","paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/ACH credit"]}},"responseCodes":["200","400","401","402","403","404","409","429","500"],"pointer":"/v2/transactions/credit","href":"transactions/flute-v2-post-transactions-credit","openApiOperationId":"flute-v2-post-transactions-credit","summary":"Credits from a transaction without reference"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/CreditRequestDto","exampleIds":["paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/Card unreferenced refund","paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/ACH credit"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditRequestDto","exampleIds":["paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/Card unreferenced refund","paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/ACH credit"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/401/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/402/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1transactions~1credit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/401/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1credit/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/flute-v2-post-transactions-credit"}],"panels":[]}]},"httpPath":"/v2/transactions/credit"},{"label":"Adjusts for tips","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/transactions/flute-v2-post-transactions-transactionid-tip-adjustment","routeSlug":"/api-reference/v2/transactions/flute-v2-post-transactions-transactionid-tip-adjustment","metadata":{"seo":{"title":"Adjusts for tips","description":"POST {{baseURL}}/v2/transactions/{{transactionId}}/tip-adjustment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-transactions-transactionId-tip-adjustment","name":"Adjusts for tips","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adjusts for tips","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-transactions-transactionId-tip-adjustment"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/transactions/{{transactionId}}/tip-adjustment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint adjusts, or adds, for tips to transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may only be used with card-present transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifically, this is for either:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorized transaction, that is, a pre-authorized transaction that hasn't been captured yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Captured transactions that have not yet settled or not fully refunded."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is a typical workflow:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For authorization: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the tip adjustment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/tip-adjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the capture: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transactionId, the UUID in the path, is returned from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the transaction settlement: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/settlements/settle"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes for the workflow:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tip adjustment requires both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant.IsTipsEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant.IsTipAdjustmentEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tip adjustment is only allowed on credit card transactions ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditDebitType.Credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), not debit cards."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement closes the entire batch for that processor, not just this one transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions/{transactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To calculate a transaction amount, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/calculate-amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To share a transaction receipt by SMS, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/share-receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transactionId","in":"path","schemaId":"schema_239","description":"Specifies the transaction identifier.\n","required":true}],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TipAdjustmentRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/TipAdjustmentRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transactionId}/tip-adjustment","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"transactionId","in":"path","required":true,"example":"487471b7-0149-44ed-840b-97d920e06829","schemaId":"schema_239"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TipAdjustmentRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","402","403","404","409","429","500"],"pointer":"/v2/transactions/{transactionId}/tip-adjustment","href":"transactions/flute-v2-post-transactions-transactionid-tip-adjustment","openApiOperationId":"flute-v2-post-transactions-transactionId-tip-adjustment","summary":"Adjusts for tips"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/TipAdjustmentRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TipAdjustmentRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/401/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/402/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/401/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/flute-v2-post-transactions-transactionid-tip-adjustment"}],"panels":[]}]},"httpPath":"/v2/transactions/{transactionId}/tip-adjustment"},{"label":"Holds an ACH transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/transactions/flute-v2-post-transactions-transactionid-ach-hold","routeSlug":"/api-reference/v2/transactions/flute-v2-post-transactions-transactionid-ach-hold","metadata":{"seo":{"title":"Holds an ACH transaction","description":"POST {{baseURL}}/v2/transactions/{{transactionId}}/ach-hold"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-transactions-transactionId-ach-hold","name":"Holds an ACH transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transactionId}~1hold/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Holds an ACH transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-transactions-transactionId-ach-hold"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/transactions/{{transactionId}}/ach-hold"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint holds an ACH transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To release a held ACH transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{{transactionId}}/ach-release"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions/{transactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To calculate a transaction amount, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/calculate-amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To share a transaction receipt by SMS, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/share-receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transactionId","in":"path","schemaId":"schema_239","description":"Specifies the transaction identifier.\n","required":true}],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1hold/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transactionId}/hold","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"transactionId","in":"path","required":true,"example":"487471b7-0149-44ed-840b-97d920e06829","schemaId":"schema_239"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","409","429","500"],"pointer":"/v2/transactions/{transactionId}/hold","href":"transactions/flute-v2-post-transactions-transactionid-ach-hold","openApiOperationId":"flute-v2-post-transactions-transactionId-ach-hold","summary":"Holds an ACH transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/401/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/402/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1hold/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/401/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/flute-v2-post-transactions-transactionid-ach-hold"}],"panels":[]}]},"httpPath":"/v2/transactions/{transactionId}/hold"},{"label":"Releases a held ACH transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/transactions/flute-v2-post-transactions-transactionid-ach-release","routeSlug":"/api-reference/v2/transactions/flute-v2-post-transactions-transactionid-ach-release","metadata":{"seo":{"title":"Releases a held ACH transaction","description":"POST {{baseURL}}/v2/transactions/{{transactionId}}/ach-release"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-transactions-transactionId-ach-release","name":"Releases a held ACH transaction","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transactionId}~1release-hold/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Releases a held ACH transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-transactions-transactionId-ach-release"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/transactions/{{transactionId}}/ach-release"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint releases a held ACH transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To hold an ACH transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/ach-hold"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions/{transactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To capture a transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To share a transaction receipt by SMS, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/share-receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transactionId","in":"path","schemaId":"schema_241","description":"Specifies the transaction identifier.\n","required":true}],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1release-hold/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transactionId}/release-hold","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"transactionId","in":"path","required":true,"example":"487471b7-0149-44ed-840b-97d920e068","schemaId":"schema_241"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","402","403","404","409","429","500"],"pointer":"/v2/transactions/{transactionId}/release-hold","href":"transactions/flute-v2-post-transactions-transactionid-ach-release","openApiOperationId":"flute-v2-post-transactions-transactionId-ach-release","summary":"Releases a held ACH transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/401/content/application~1json/example"]},{"code":"402","description":"Payment Required","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/402/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/402/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageOfGetTransactionResponseDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/401/content/application~1json/example"]}}},{"code":"402","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/402/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/402/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/flute-v2-post-transactions-transactionid-ach-release"}],"panels":[]}]},"httpPath":"/v2/transactions/{transactionId}/release-hold"},{"label":"Calculates transaction amounts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/transactions/flute-v2-post-transactions-calculate-amount","routeSlug":"/api-reference/v2/transactions/flute-v2-post-transactions-calculate-amount","metadata":{"seo":{"title":"Calculates transaction amounts","description":"POST {{baseURL}}/v2/transactions/calculate-amount"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-transactions-calculate-amount","name":"Calculates transaction amounts","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1calculate-amount/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calculates transaction amounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-transactions-calculate-amount"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/transactions/calculate-amount"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint calculates transaction amounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amounts are based on the merchant's ZCP (zero cost processing) mode."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes dual pricing, cash discounts, or credit card surcharges."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applications, such as payment terminals or point of service devices, can then display the appropriate amounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions/{transactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To share a transaction receipt by SMS, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/share-receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_242","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_242","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1transactions~1calculate-amount/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/calculate-amount","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_242","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/transactions/calculate-amount","href":"transactions/flute-v2-post-transactions-calculate-amount","openApiOperationId":"flute-v2-post-transactions-calculate-amount","summary":"Calculates transaction amounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"schema_242","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_242","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalculateAmountResponseDto","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CalculateAmountResponseDto","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/403/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1transactions~1calculate-amount/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CalculateAmountResponseDto","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CalculateAmountResponseDto","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1calculate-amount/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/flute-v2-post-transactions-calculate-amount"}],"panels":[]}]},"httpPath":"/v2/transactions/calculate-amount"},{"label":"Sends a transaction receipt by SMS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/transactions/flute-v2-post-transactions-transactionid-share-receipt","routeSlug":"/api-reference/v2/transactions/flute-v2-post-transactions-transactionid-share-receipt","metadata":{"seo":{"title":"Sends a transaction receipt by SMS","description":"POST {{baseURL}}/v2/transactions/{{transactionId}}/share-receipt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-transactions-transactionId-share-receipt","name":"Sends a transaction receipt by SMS","isWebhook":false,"pointer":"/paths/~1v2~1transactions~1{transactionId}~1share-receipt/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends a transaction receipt by SMS","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-transactions-transactionId-share-receipt"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/transactions/{{transactionId}}/share-receipt"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint shares a transaction receipt by SMS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is a typical workflow:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For authorization: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For sharing the receipt: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/transactions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/share-receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transactionId, the UUID in the path, is returned from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A successful response is 200 OK with no response body."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes for the workflow:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hasCustomerConsent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required and must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoint will reject the request if the customer has not explicitly consented to receive an SMS."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mobileNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not have to match the one on the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A receipt can be sent to any phone number the customer provides at time of receipt."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list transactions, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a transaction by ID, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/transactions/{transactionId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a new transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To capture a transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To reverse a transaction, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transactionId","in":"path","schemaId":"schema_243","description":"Specifies the transaction identifier to send a receipt for.\n","required":true}],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendReceiptRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/SendReceiptRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/requestBody","description":"Specifies the recipient mobile number for the SMS receipt."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/transactions/{transactionId}/share-receipt","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"transactionId","in":"path","required":true,"example":"e6d064c0-b2a5-4cb3-bc57-8135123ed791","schemaId":"schema_243"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SendReceiptRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/transactions/{transactionId}/share-receipt","href":"transactions/flute-v2-post-transactions-transactionid-share-receipt","openApiOperationId":"flute-v2-post-transactions-transactionId-share-receipt","summary":"Sends a transaction receipt by SMS"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/SendReceiptRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SendReceiptRequestDto","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The receipt was successfully shared."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/flute-v2-post-transactions-transactionid-share-receipt"}],"panels":[]}]},"httpPath":"/v2/transactions/{transactionId}/share-receipt"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"payment-transactions-overview"}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At the center of Flute's payments model is the "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction is a record created every time money moves through a merchant's account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A transaction is created with a single call: "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every transaction carries the same core shape regardless of payment type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentProcessorId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies the processor handling the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"baseAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specify the transaction amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies a value the merchant chooses for their own bookkeeping."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specifies an object holding either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"achData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" depending on how the customer is paying."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each transaction goes through the same endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It comes back with the same response envelope, just populated with different "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processorResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This includes whether someone is charging a saved card, running a brand-new card number inline, or debiting a bank account through ACH."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card transactions carry an extra decision point that ACH doesn't: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"captureMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is set to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" capture means the authorization and the capture happen in one step, and the transaction lands in an Approved state immediately, ready to settle."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" capture splits it into two steps: the initial call only authorizes the funds and returns a Pending transaction, and a separate call to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/capture"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" later finalizes it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This distinction matters most for merchants who need to confirm inventory or finalize an order total."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a restaurant might close a tab with tips added before actually pulling the money."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It's why the API treats \"money authorized\" and \"money captured\" as two different states rather than collapsing them into one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once a transaction is captured or approved, several other endpoints act on it rather than creating a new one."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reverses a transaction outright."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/tip-adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lets a merchant amend the tip on an existing charge, common in card-present environments where the tip is added after the initial swipe."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pulling money back after settlement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for issuing money without tying it to a prior reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions/{transactionId}/ach-hold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for placing a hold on a pending ACH transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every transaction also comes back with a rich "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processorResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" breakdown rather than just a status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separates "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"baseAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A merchant can see exactly how a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was assembled instead of just the final total."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processorResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reports which underlying processor ran the transaction, TSYS, for instance, on the card examples in the spec, or a plain ACH label for bank debits, along with a response code and a human-readable message."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For card transactions there's also an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"addressVerificationServiceResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", showing whether the billing address and the postal or ZIP code the customer supplied matched what the card issuer has on file."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is one of the signals merchants use to judge fraud risk on a given charge."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is an example of a basic transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A merchant charges $100 on a saved card with auto-capture, and the customer adds a $15 tip at checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request "},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"paymentProcessorId\": \"a2f2c2e7-0b23-4682-8f99-ab7707205461\",\n    \"baseAmount\": 100.00,\n    \"currencyCode\": \"USD\",\n    \"referenceId\": \"REF-CARD-SALE-001\",\n    \"isCustomerInitiatedTransaction\": true,\n    \"pricingType\": \"Card\",\n    \"transactionDetails\": {\n        \"cardData\": {\n            \"captureMethod\": \"Auto\",\n            \"paymentMethodId\": \"e397e367-bc4a-4b69-bd78-32e3e12327c2\"\n        }\n    }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"paymentProcessorId\": \"a2f2c2e7-0b23-4682-8f99-ab7707205461\",\n    \"baseAmount\": 100.00,\n    \"currencyCode\": \"USD\",\n    \"referenceId\": \"REF-CARD-SALE-001\",\n    \"isCustomerInitiatedTransaction\": true,\n    \"pricingType\": \"Card\",\n    \"transactionDetails\": {\n        \"cardData\": {\n            \"captureMethod\": \"Auto\",\n            \"paymentMethodId\": \"e397e367-bc4a-4b69-bd78-32e3e12327c2\"\n        }\n    }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"captureMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Flute authorizes and captures the charge in the same call."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response comes back already settled from the API's perspective:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    \"transactionId\": \"5f6f782f-37af-44e1-bb18-2bc35e411899\",\n    \"transactionStatus\": \"Approved\",\n    \"processedAmount\": 115.5,\n    \"currencyCode\": \"USD\",\n    \"amountDetails\":\n    {\n        \"baseAmount\": 100.00,\n        \"tipAmount\": 15,\n        \"surchargeAmount\": 3,\n        \"discountAmount\": 2.5\n    },\n    \"processorResponse\":\n    {\n        \"processorName\": \"TSYS\",\n        \"responseCode\": \"00\",\n        \"responseMessage\": \"Approved\",\n        \"responseDefinition\": \"Approved and completed\"\n    },\n    \"addressVerificationServiceResponse\":\n    {\n        \"action\": \"Allow\",\n        \"responseCode\": \"Y\",\n        \"description\": \"Address and ZIP match\"\n    }\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    \"transactionId\": \"5f6f782f-37af-44e1-bb18-2bc35e411899\",\n    \"transactionStatus\": \"Approved\",\n    \"processedAmount\": 115.5,\n    \"currencyCode\": \"USD\",\n    \"amountDetails\":\n    {\n        \"baseAmount\": 100.00,\n        \"tipAmount\": 15,\n        \"surchargeAmount\": 3,\n        \"discountAmount\": 2.5\n    },\n    \"processorResponse\":\n    {\n        \"processorName\": \"TSYS\",\n        \"responseCode\": \"00\",\n        \"responseMessage\": \"Approved\",\n        \"responseDefinition\": \"Approved and completed\"\n    },\n    \"addressVerificationServiceResponse\":\n    {\n        \"action\": \"Allow\",\n        \"responseCode\": \"Y\",\n        \"description\": \"Address and ZIP match\"\n    }\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processedAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ($115.50) reflects the base charge plus the tip and a surcharge, minus a discount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is exactly as itemized in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amountDetails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction is done."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is no separate capture call needed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This merchant chose the auto-capture path rather than the authorize-then-capture flow used for something like a restaurant tab."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/transactions","summary":"Lists transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/flute-v2-get-transactions","deprecated":false},{"title":"/v2/transactions","summary":"Creates a transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/flute-v2-post-transactions","deprecated":false},{"title":"/v2/transactions/{transactionId}","summary":"Retrieves a transaction by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/flute-v2-get-transactions-transactionid","deprecated":false},{"title":"/v2/transactions/{transactionId}/capture","summary":"Captures a transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/flute-v2-post-transactions-transactionid-capture","deprecated":false},{"title":"/v2/transactions/{transactionId}/reversal","summary":"Reverses a transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/flute-v2-post-transactions-transactionid-reversal","deprecated":false},{"title":"/v2/transactions/credit","summary":"Credits from a transaction without reference","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/flute-v2-post-transactions-credit","deprecated":false},{"title":"/v2/transactions/{transactionId}/tip-adjustment","summary":"Adjusts for tips","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/flute-v2-post-transactions-transactionid-tip-adjustment","deprecated":false},{"title":"/v2/transactions/{transactionId}/hold","summary":"Holds an ACH transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/flute-v2-post-transactions-transactionid-ach-hold","deprecated":false},{"title":"/v2/transactions/{transactionId}/release-hold","summary":"Releases a held ACH transaction","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/flute-v2-post-transactions-transactionid-ach-release","deprecated":false},{"title":"/v2/transactions/calculate-amount","summary":"Calculates transaction amounts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/flute-v2-post-transactions-calculate-amount","deprecated":false},{"title":"/v2/transactions/{transactionId}/share-receipt","summary":"Sends a transaction receipt by SMS","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transactions/flute-v2-post-transactions-transactionid-share-receipt","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/api-reference/v2/webhooks","routeSlug":"/api-reference/v2/webhooks","items":[{"label":"Lists webhook endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/webhooks/flute-v2-get-webhooks-endpoints","routeSlug":"/api-reference/v2/webhooks/flute-v2-get-webhooks-endpoints","metadata":{"seo":{"title":"Lists webhook endpoints","description":"GET {{baseURL}}/v2/webhooks/endpoints"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-webhooks-endpoints","name":"Lists webhook endpoints","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1endpoints/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists webhook endpoints","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-webhooks-endpoints"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/webhooks/endpoints"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists all webhook endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The endpoints are for both active and inactive webhooks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/webhooks/endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a specified webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/endpoints/{{endpointId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/webhooks/endpoints/{{endpointId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageIndex","in":"query","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the page number of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value restrictions include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value less than zero is not permitted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values equal to or greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end successfully but will not return any items."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page size information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 0"},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of items for each page of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page numbering information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 50"},"children":[]}]}]}]},{"name":"sortOrder","in":"query","schemaId":"schema_209","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sort order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort order is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field that gets sorted by is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"asc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results from the lowest value to the highest value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"desc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results from the highest value to the lowest value."},"children":[]}]}]}]}]}]}],"example":"desc"},{"name":"sortBy","in":"query","schemaId":"schema_193","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the field the results get ordered or sorted by."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort order is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field that gets sorted by is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"example":"ContactName"},{"name":"fromDate","in":"query","schemaId":"schema_211","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters returning items on or after this date (in an ISO 8601 date-time format) to filter by,."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to the present."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an exclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an exclusive range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"toDate","in":"query","schemaId":"schema_212","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters returning items on or to this date (in an ISO 8601 date-time format) to filter by,."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items up to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an exclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an explicit range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"endpointStatus","in":"query","schemaId":"schema_244","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters by the endpoint status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook endpoint is enabled and available for use."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inactive"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook endpoint is disabled and not available for use."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It still exists but will not send event notifications. It may be re-activated. In contrast, a deleted webhook has been removed entirely and cannot be re-activated. A new webhook must be created."},"children":[]}]}]}]}]}]}]},{"name":"search","in":"query","schemaId":"schema_196","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters using a search string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a partial, case-insensitive text search."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following fields are searched:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpointName"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpointUrl"},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1webhooks~1endpoints/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/webhooks/endpoints","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"pageIndex","in":"query","schemaId":"schema_190"},{"name":"pageSize","in":"query","schemaId":"schema_191"},{"name":"sortOrder","in":"query","example":"desc","schemaId":"schema_209"},{"name":"sortBy","in":"query","example":"ContactName","schemaId":"schema_193"},{"name":"fromDate","in":"query","example":"2025-01-27T12:05:54.322Z","schemaId":"schema_211"},{"name":"toDate","in":"query","example":"2026-02-27T12:05:54.322Z","schemaId":"schema_212"},{"name":"endpointStatus","in":"query","example":"Active","schemaId":"schema_244"},{"name":"search","in":"query","example":"Peppared Street Cafe","schemaId":"schema_196"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/webhooks/endpoints","href":"webhooks/flute-v2-get-webhooks-endpoints","openApiOperationId":"flute-v2-get-webhooks-endpoints","summary":"Lists webhook endpoints"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListWebhookEndpointsIsvResponseDto"}},"schemaId":"components/schemas/ListWebhookEndpointsIsvResponseDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/403/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1webhooks~1endpoints/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListWebhookEndpointsIsvResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListWebhookEndpointsIsvResponseDto"}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/flute-v2-get-webhooks-endpoints"}],"panels":[]}]},"httpPath":"/v2/webhooks/endpoints"},{"label":"Creates a webhook endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/webhooks/flute-v2-post-webhooks-endpoints","routeSlug":"/api-reference/v2/webhooks/flute-v2-post-webhooks-endpoints","metadata":{"seo":{"title":"Creates a webhook endpoint","description":"POST {{baseURL}}/v2/webhooks/endpoints"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-webhooks-endpoints","name":"Creates a webhook endpoint","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1endpoints/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-webhooks-endpoints"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/webhooks/endpoints"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint creates a new webhook endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New endpoints default to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on creation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints are eligible for real event dispatch."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list all of available webhooks, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a specified webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/endpoints/{{endpointId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/webhooks/endpoints/{{endpointId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/webhooks/endpoints/{{endpointId}}"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_245"}},"schemaId":"schema_245","pointer":"/paths/~1v2~1webhooks~1endpoints/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/webhooks/endpoints","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_245"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/webhooks/endpoints","href":"webhooks/flute-v2-post-webhooks-endpoints","openApiOperationId":"flute-v2-post-webhooks-endpoints","summary":"Creates a webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"schema_245","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_245"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateWebhookEndpointIsvResponseDto","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreateWebhookEndpointIsvResponseDto","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1webhooks~1endpoints/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateWebhookEndpointIsvResponseDto","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateWebhookEndpointIsvResponseDto","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/flute-v2-post-webhooks-endpoints"}],"panels":[]}]},"httpPath":"/v2/webhooks/endpoints"},{"label":"Retrieves a webhook endpoint by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/webhooks/flute-v2-get-webhooks-endpoints-endpointid","routeSlug":"/api-reference/v2/webhooks/flute-v2-get-webhooks-endpoints-endpointid","metadata":{"seo":{"title":"Retrieves a webhook endpoint by ID","description":"GET {{baseURL}}/v2/webhooks/endpoints/{{endpointId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-webhooks-endpoints-endpointId","name":"Retrieves a webhook endpoint by ID","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a webhook endpoint by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-webhooks-endpoints-endpointId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/webhooks/endpoints/{{endpointId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a webhook endpoint by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list all available webhooks, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/webhooks/endpoints/{{endpointId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To test a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/webhooks/endpoints/{{endpointId}}/ping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"endpointId","in":"path","schemaId":"schema_246","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the webhook identifier to retrieve."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/webhooks/endpoints/{endpointId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"endpointId","in":"path","required":true,"example":"0dab4e68-8d18-42ce-93ba-77b0e8dbafdc","schemaId":"schema_246"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v2/webhooks/endpoints/{endpointId}","href":"webhooks/flute-v2-get-webhooks-endpoints-endpointid","openApiOperationId":"flute-v2-get-webhooks-endpoints-endpointId","summary":"Retrieves a webhook endpoint by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWebhookEndpointIsvResponseDto"}},"schemaId":"components/schemas/GetWebhookEndpointIsvResponseDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetWebhookEndpointIsvResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWebhookEndpointIsvResponseDto"}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/flute-v2-get-webhooks-endpoints-endpointid"}],"panels":[]}]},"httpPath":"/v2/webhooks/endpoints/{endpointId}"},{"label":"Updates a webhook endpoint","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/webhooks/flute-v2-patch-webhooks-endpoints-endpointid","routeSlug":"/api-reference/v2/webhooks/flute-v2-patch-webhooks-endpoints-endpointid","metadata":{"seo":{"title":"Updates a webhook endpoint","description":"PATCH {{baseURL}}/v2/webhooks/endpoints/{{endpointId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-patch-webhooks-endpoints-endpointId","name":"Updates a webhook endpoint","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-patch-webhooks-endpoints-endpointId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PATCH {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/webhooks/endpoints/{{endpointId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint updates a webhook endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list all available  webhooks, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a specified webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/endpoints/{{endpointId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#flute-v2-api-keys-{{clientId}}"}},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/webhooks/endpoints/{{endpointId}}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"style":{"fontSize":"8pt"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n  [ "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"#patch_v2_webhooks_endpoints_endpointId_request_body"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Query parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ]\n  [ "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"#patch_v2_webhooks_endpoints_endpointId_response_body"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Response fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" ]\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"endpointId","in":"path","schemaId":"schema_247","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the webhook identifier to retrieve."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updatewebhookendpointisvrequestdto","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/updatewebhookendpointisvrequestdto","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"patch_v2_webhooks_endpoints_endpointId_request_body"}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is a partial update."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send only the fields needed to be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An omitted field is left unchanged."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A field marked with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" clears a field."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2/webhooks/endpoints/{endpointId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"endpointId","in":"path","required":true,"example":"76804cf3-4a5b-4c6d-7e8f-9a0b1c2d3e69","schemaId":"schema_247"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/updatewebhookendpointisvrequestdto","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","404","500"],"pointer":"/v2/webhooks/endpoints/{endpointId}","href":"webhooks/flute-v2-patch-webhooks-endpoints-endpointid","openApiOperationId":"flute-v2-patch-webhooks-endpoints-endpointId","summary":"Updates a webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"schemaId":"components/schemas/updatewebhookendpointisvrequestdto","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updatewebhookendpointisvrequestdto","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"patch_v2_webhooks_endpoints_endpointId_response_body"}},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWebhookEndpointIsvResponseDto"}},"schemaId":"components/schemas/GetWebhookEndpointIsvResponseDto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetWebhookEndpointIsvResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWebhookEndpointIsvResponseDto"}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/flute-v2-patch-webhooks-endpoints-endpointid"}],"panels":[]}]},"httpPath":"/v2/webhooks/endpoints/{endpointId}"},{"label":"Deletes a webhook endpoint","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/webhooks/flute-v2-delete-webhooks-endpoints-endpointid","routeSlug":"/api-reference/v2/webhooks/flute-v2-delete-webhooks-endpoints-endpointid","metadata":{"seo":{"title":"Deletes a webhook endpoint","description":"DELETE {{baseURL}}/v2/webhooks/endpoints/{{endpointId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-delete-webhooks-endpoints-endpointId","name":"Deletes a webhook endpoint","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-delete-webhooks-endpoints-endpointId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DELETE {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/webhooks/endpoints/{{endpointId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint deletes a webhook endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All outstanding pending and scheduled retries for this specified webhook are cancelled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"References in log files are not erased."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/webhooks/endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/webhooks/endpoints/{{endpointId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To test a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/webhooks/endpoints/{{endpointId}}/ping"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"endpointId","in":"path","schemaId":"schema_248","description":"Specifies the webhook identifier to delete.\n","required":true}],"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/webhooks/endpoints/{endpointId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"endpointId","in":"path","required":true,"example":"e8570526-3b2c-4776-ad1c-1303ccb5bc2d","schemaId":"schema_248"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","409","429","500"],"pointer":"/v2/webhooks/endpoints/{endpointId}","href":"webhooks/flute-v2-delete-webhooks-endpoints-endpointid","openApiOperationId":"flute-v2-delete-webhooks-endpoints-endpointId","summary":"Deletes a webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. The webhook was successfully deleted."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/403/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/flute-v2-delete-webhooks-endpoints-endpointid"}],"panels":[]}]},"httpPath":"/v2/webhooks/endpoints/{endpointId}"},{"label":"Pings a webhook endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/webhooks/flute-v2-post-webhooks-endpoints-endpointid-ping","routeSlug":"/api-reference/v2/webhooks/flute-v2-post-webhooks-endpoints-endpointid-ping","metadata":{"seo":{"title":"Pings a webhook endpoint","description":"GET {{baseURL}}/v2/webhooks/endpoints/{{endpointId}}/ping"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-webhooks-endpoints-endpointId-ping","name":"Pings a webhook endpoint","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pings a webhook endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-webhooks-endpoints-endpointId-ping"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/webhooks/endpoints/{{endpointId}}/ping"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint validates connectivity to the registered endpoint URL."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"endpointId","in":"path","schemaId":"schema_249","description":"Specifies the webhook endpoint identifier to ping.\n","required":true,"example":"c94e10ae-378e-4124-9b35-ecdfb9085a62"}],"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/webhooks/endpoints/{endpointId}/ping","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"endpointId","in":"path","required":true,"example":"c94e10ae-378e-4124-9b35-ecdfb9085a62","schemaId":"schema_249"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/webhooks/endpoints/{endpointId}/ping","href":"webhooks/flute-v2-post-webhooks-endpoints-endpointid-ping","openApiOperationId":"flute-v2-post-webhooks-endpoints-endpointId-ping","summary":"Pings a webhook endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/pingwebhookisvresponsedto","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/pingwebhookisvresponsedto","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/pingwebhookisvresponsedto","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/pingwebhookisvresponsedto","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/flute-v2-post-webhooks-endpoints-endpointid-ping"}],"panels":[]}]},"httpPath":"/v2/webhooks/endpoints/{endpointId}/ping"},{"label":"Lists webhook event types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/webhooks/flute-v2-get-webhooks-event-types","routeSlug":"/api-reference/v2/webhooks/flute-v2-get-webhooks-event-types","metadata":{"seo":{"title":"Lists webhook event types","description":"GET {{baseURL}}/v2/webhooks/event-types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-webhooks-event-types","name":"Lists webhook event types","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1event-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists webhook event types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-webhooks-event-types"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/webhooks/event-types"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists available webhook event types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of available webhook event types are provided by Flute."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These are the only events types available to be selected from."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operating system or other company's events cannot be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each webhook must include at least one."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple events types may be included in a specific webhook but duplicates are not allowed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each webhook is independent from other webhooks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The same events type may be included in different webhooks."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of events types do not have to relate to each other."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the set of all event types of interest for the client."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clients may create multiple webhooks to provide granularity for their processes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In that case, the set of events types would likely be related for the client's intent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/webhooks/endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To update a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/webhooks/endpoints/{{endpointId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/webhooks/event-types","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","500"],"pointer":"/v2/webhooks/event-types","href":"webhooks/flute-v2-get-webhooks-event-types","openApiOperationId":"flute-v2-get-webhooks-event-types","summary":"Lists webhook event types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListWebhookEndpointsIsvResponseDto"}},"schemaId":"components/schemas/ListWebhookEndpointsIsvResponseDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1event-types/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1event-types/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1webhooks~1event-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListWebhookEndpointsIsvResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListWebhookEndpointsIsvResponseDto"}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1event-types/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1event-types/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/flute-v2-get-webhooks-event-types"}],"panels":[]}]},"httpPath":"/v2/webhooks/event-types"},{"label":"Lists webhook delivery logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/webhooks/flute-v2-get-webhooks-delivery-logs","routeSlug":"/api-reference/v2/webhooks/flute-v2-get-webhooks-delivery-logs","metadata":{"seo":{"title":"Lists webhook delivery logs","description":"GET {{baseURL}}/v2/webhooks/delivery-logs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-webhooks-delivery-logs","name":"Lists webhook delivery logs","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1delivery-logs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists webhook delivery logs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-webhooks-delivery-logs"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/webhooks/delivery-logs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists webhook delivery logs for the merchant account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list all available webhooks, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a specified delivery log, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/delivery-logs/{{endpointId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To export delivery log, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/delivery-logs/export"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters may be combined to filter the exported results."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageIndex","in":"query","schemaId":"schema_190","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the page number of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value restrictions include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value less than zero is not permitted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values equal to or greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end successfully but will not return any items."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page size information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 0"},"children":[]}]}]}]},{"name":"pageSize","in":"query","schemaId":"schema_191","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the number of items for each page of the returned search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page is considered each set of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The page count is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or the page number, is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" divided by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count rounded down."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 50 and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 130."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That means there are three pages, but the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is in the inclusive range from zero to two."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For page numbering information, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 50"},"children":[]}]}]}]},{"name":"sortBy","in":"query","schemaId":"schema_193","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the field the results get ordered or sorted by."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort order is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field that gets sorted by is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]}],"example":"ContactName"},{"name":"sortOrder","in":"query","schemaId":"schema_209","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sort order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sort order is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field that gets sorted by is specified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"asc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results from the lowest value to the highest value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"desc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results from the highest value to the lowest value."},"children":[]}]}]}]}]}]}],"example":"desc"},{"name":"endpointId","in":"query","schemaId":"schema_246","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the webhook identifier to filter by."},"children":[]}]}]}]},{"name":"eventType","in":"query","schemaId":"schema_250","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters delivery logs to a single event type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit this parameter to include all event types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wire value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Group"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"api_key.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys (affiliate only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"api_key.deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key was revoked or deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys (affiliate only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new invoice was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoices"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice.paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An invoice was marked as paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoices"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchant.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new merchant account was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchants (affiliate only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_session.completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment session reached a terminal state (completed, failed, or cancelled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Sessions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_session.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment session was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Sessions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quick_payment.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A quick payment link was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quick Payments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quick_payment.paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A quick payment link was paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quick Payments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement.batch.completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A batch settlement was processed and settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new subscription was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription.delinquent"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription entered a delinquent state after repeated payment failures"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription.paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription payment was successfully collected"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription.payment_failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription payment attempt failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal.added"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new terminal was registered to the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal.deactivated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A terminal was deactivated on the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal.out_of_paper"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A terminal paper roll is empty"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was cancelled before processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.charged_back"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was returned or charged back"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.cleared"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction successfully cleared"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction failed due to a processing error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.held"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was placed on hold for review"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.in_progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was submitted to the network"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.refunded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was refunded to the originator"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.scheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was created and scheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.authorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment authorization was approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.captured"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An authorized card payment was captured"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment was declined by the issuer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment failed due to a processing error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.refunded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment was refunded to the cardholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.voided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card authorization was voided before capture"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]}]}]}],"example":"transaction.card.captured"},{"name":"deliveryLogStatus","in":"query","schemaId":"schema_251","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters by the delivery success status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery succeeded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery failed"},"children":[]}]}]}]}]}]}]},{"name":"endpointHTTPResponseCode","in":"query","schemaId":"schema_252","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters by the HTTP response status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the HTTP status code returned by the attempted delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is a list of HTTP response status codes that include but are not limited to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery succeeded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint not found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limited"},"children":[]}]}]}]}]}]}]},{"name":"fromDate","in":"query","schemaId":"schema_211","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters returning webhooks created on or after this date (in an ISO 8601 date-time format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to the present."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an exclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an exclusive range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"toDate","in":"query","schemaId":"schema_212","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters returning webhooks created on or to this date (in an ISO 8601 date-time format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items up to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an exclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an explicit range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"search","in":"query","schemaId":"schema_253","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters using a search string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This performs a case-insensitive search that matches exactly or partially."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field does not have to be specified."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the results are to be sorted, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderby"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to specify the sort field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The search includes the following fields:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EventId (Exact match and complete UUID only. Otherwise, this value is ignored.)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WebhookName"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EndpointUrl"},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1webhooks~1delivery-logs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/webhooks/delivery-logs","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"pageIndex","in":"query","schemaId":"schema_190"},{"name":"pageSize","in":"query","schemaId":"schema_191"},{"name":"sortBy","in":"query","example":"ContactName","schemaId":"schema_193"},{"name":"sortOrder","in":"query","example":"desc","schemaId":"schema_209"},{"name":"endpointId","in":"query","example":"0dab4e68-8d18-42ce-93ba-77b0e8dbafdc","schemaId":"schema_246"},{"name":"eventType","in":"query","required":false,"example":"transaction.card.captured","schemaId":"schema_250"},{"name":"deliveryLogStatus","in":"query","example":"Success","schemaId":"components/schemas/webhookdeliverylogstatus"},{"name":"endpointHTTPResponseCode","in":"query","example":401,"schemaId":"schema_252"},{"name":"fromDate","in":"query","example":"2025-01-27T12:05:54.322Z","schemaId":"schema_211"},{"name":"toDate","in":"query","example":"2026-02-27T12:05:54.322Z","schemaId":"schema_212"},{"name":"search","in":"query","schemaId":"schema_253"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v2/webhooks/delivery-logs","href":"webhooks/flute-v2-get-webhooks-delivery-logs","openApiOperationId":"flute-v2-get-webhooks-delivery-logs","summary":"Lists webhook delivery logs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/listwebhookdeliverylogsisvresponsedto"}},"schemaId":"components/schemas/listwebhookdeliverylogsisvresponsedto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1webhooks~1delivery-logs/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/listwebhookdeliverylogsisvresponsedto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/listwebhookdeliverylogsisvresponsedto"}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/flute-v2-get-webhooks-delivery-logs"}],"panels":[]}]},"httpPath":"/v2/webhooks/delivery-logs"},{"label":"Retrieves a delivery log by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/webhooks/flute-v2-get-webhooks-delivery-logs-deliverylogid","routeSlug":"/api-reference/v2/webhooks/flute-v2-get-webhooks-delivery-logs-deliverylogid","metadata":{"seo":{"title":"Retrieves a delivery log by ID","description":"GET {{baseURL}}/v2/webhooks/delivery-logs/{{deliveryLogId}}"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-webhooks-delivery-logs-deliveryLogId","name":"Retrieves a delivery log by ID","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a delivery log by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-webhooks-delivery-logs-deliveryLogId"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/webhooks/delivery-logs/{{deliveryLogId}}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a delivery log by ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list all available webhooks, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To test a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/webhooks/endpoints/{{endpointId}}/ping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To manually retry a webhook delivery attempt, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/webhooks/delivery-logs/{{deliveryLogId}}/retry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"deliveryLogId","in":"query","schemaId":"schema_254","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the delivery log identifier to retrieve."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/webhooks/delivery-logs/{deliveryLogId}","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"deliveryLogId","in":"query","example":"30d1d958-cf5a-446c-be96-5a78b2220c19","schemaId":"schema_254"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","403","404","429","500"],"pointer":"/v2/webhooks/delivery-logs/{deliveryLogId}","href":"webhooks/flute-v2-get-webhooks-delivery-logs-deliverylogid","openApiOperationId":"flute-v2-get-webhooks-delivery-logs-deliveryLogId","summary":"Retrieves a delivery log by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhookdeliverylogisvdetaildto","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/webhookdeliverylogisvdetaildto","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhookdeliverylogisvdetaildto","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhookdeliverylogisvdetaildto","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/flute-v2-get-webhooks-delivery-logs-deliverylogid"}],"panels":[]}]},"httpPath":"/v2/webhooks/delivery-logs/{deliveryLogId}"},{"label":"Exports webhook delivery logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/webhooks/flute-v2-get-webhooks-delivery-logs-export","routeSlug":"/api-reference/v2/webhooks/flute-v2-get-webhooks-delivery-logs-export","metadata":{"seo":{"title":"Exports webhook delivery logs","description":"GET {{baseURL}}/v2/webhooks/delivery-logs/export"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-get-webhooks-delivery-logs-export","name":"Exports webhook delivery logs","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1delivery-logs~1export/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exports webhook delivery logs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-get-webhooks-delivery-logs-export"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/webhooks/delivery-logs/export"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint exports webhook delivery logs as a CSV or JSON file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters may be combined to filter the exported results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list all available webhooks, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list all delivery logs, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/delivery-logs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a specified delivery log, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/delivery-logs/{{endpointId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"endpointId","in":"query","schemaId":"schema_255","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the webhook identifier to retrieve."},"children":[]}]}]}]},{"name":"eventType","in":"query","schemaId":"schema_250","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters delivery logs to a single event type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit this parameter to include all event types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wire value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Group"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"api_key.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys (affiliate only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"api_key.deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key was revoked or deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys (affiliate only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new invoice was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoices"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice.paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An invoice was marked as paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoices"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchant.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new merchant account was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchants (affiliate only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_session.completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment session reached a terminal state (completed, failed, or cancelled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Sessions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_session.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment session was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Sessions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quick_payment.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A quick payment link was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quick Payments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quick_payment.paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A quick payment link was paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quick Payments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement.batch.completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A batch settlement was processed and settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new subscription was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription.delinquent"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription entered a delinquent state after repeated payment failures"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription.paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription payment was successfully collected"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription.payment_failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription payment attempt failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal.added"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new terminal was registered to the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal.deactivated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A terminal was deactivated on the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal.out_of_paper"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A terminal paper roll is empty"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was cancelled before processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.charged_back"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was returned or charged back"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.cleared"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction successfully cleared"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction failed due to a processing error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.held"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was placed on hold for review"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.in_progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was submitted to the network"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.refunded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was refunded to the originator"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.scheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was created and scheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.authorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment authorization was approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.captured"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An authorized card payment was captured"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment was declined by the issuer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment failed due to a processing error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.refunded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment was refunded to the cardholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.voided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card authorization was voided before capture"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]}]}]}],"example":"transaction.card.captured"},{"name":"deliveryLogStatus","in":"query","schemaId":"schema_251","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the delivery success status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery succeeded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery failed"},"children":[]}]}]}]}]}]}]},{"name":"endpointHTTPResponseCode","in":"query","schemaId":"schema_256","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the HTTP response status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the HTTP status code returned by the attempted delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is a list of HTTP response status codes that include but are not limited to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery succeeded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint not found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limited"},"children":[]}]}]}]}]}]}]},{"name":"dateFrom","in":"query","schemaId":"schema_211","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters returning items on or after this date (in an ISO 8601 date-time format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to the present."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an inclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an explicit range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"dateTo","in":"query","schemaId":"schema_212","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters returning items on or to this date (in an ISO 8601 date-time format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified, the search returns all available items before including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateFrom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dateTo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be used together to create an inclusive range."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend creating an explicit range to avoid a potentially excessive number of returns."},"children":[]}]}]}]},{"name":"format","in":"query","schemaId":"schema_257","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the data format to return the items in."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Csv"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the export as a CSV file."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the export as a JSON file."},"children":[]}]}]}]}]}]}]}],"pointer":"/paths/~1v2~1webhooks~1delivery-logs~1export/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/webhooks/delivery-logs/export","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[],"query":[{"name":"endpointId","in":"query","example":"a9b37f26-7d8e-4f9a-0b1c-2d3e4f5a6b92","schemaId":"schema_255"},{"name":"eventType","in":"query","required":false,"example":"transaction.card.captured","schemaId":"schema_250"},{"name":"deliveryLogStatus","in":"query","example":"Success","schemaId":"components/schemas/webhookdeliverylogstatus"},{"name":"endpointHTTPResponseCode","in":"query","example":200,"schemaId":"schema_256"},{"name":"dateFrom","in":"query","example":"2025-01-27T12:05:54.322Z","schemaId":"schema_211"},{"name":"dateTo","in":"query","example":"2026-02-27T12:05:54.322Z","schemaId":"schema_212"},{"name":"format","in":"query","example":"Csv","schemaId":"schema_257"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/v2/webhooks/delivery-logs/export","href":"webhooks/flute-v2-get-webhooks-delivery-logs-export","openApiOperationId":"flute-v2-get-webhooks-delivery-logs-export","summary":"Exports webhook delivery logs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"text/csv","mediaTypes":["text/csv","application/json"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_258"},"application/json":{"schemaId":"schema_258"}},"schemaId":"schema_258"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/403/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1webhooks~1delivery-logs~1export/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_258","mediaTypes":["text/csv","application/json"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_258"},"application/json":{"schemaId":"schema_258"}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/flute-v2-get-webhooks-delivery-logs-export"}],"panels":[]}]},"httpPath":"/v2/webhooks/delivery-logs/export"},{"label":"Retries a failed webhook delivery","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/v2/webhooks/flute-v2-post-webhooks-delivery-logs-deliverylogid-retry","routeSlug":"/api-reference/v2/webhooks/flute-v2-post-webhooks-delivery-logs-deliverylogid-retry","metadata":{"seo":{"title":"Retries a failed webhook delivery","description":"POST {{baseURL}}/v2/webhooks/delivery-logs/{{endpointId}}/retry"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"flute-v2-post-webhooks-delivery-logs-deliveryLogId-retry","name":"Retries a failed webhook delivery","isWebhook":false,"pointer":"/paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retries a failed webhook delivery","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"flute-v2-post-webhooks-delivery-logs-deliveryLogId-retry"}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-endpoint"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POST {{"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#urlbases"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseURL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}}/v2/webhooks/delivery-logs/{{endpointId}}/retry"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint manually retries a failed webhook delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a single try each time."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It does not automatically retry multiple times."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It does not interfere with or interrupt the normal retry procedures."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"api-seealso"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See Also:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list all available webhooks, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To test a webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/webhooks/endpoints/{{endpointId}}/ping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list all available delivery logs, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/delivery-logs"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deliveryLogId","in":"path","schemaId":"schema_259","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the delivery log identifier to retry."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/webhooks/delivery-logs/{deliveryLogId}/retry","servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"parameters":{"path":[{"name":"deliveryLogId","in":"path","required":true,"example":"87915d04-5b6c-4d7e-8f9a-0b1c2d3e4f70","schemaId":"schema_259"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/v2/webhooks/delivery-logs/{deliveryLogId}/retry","href":"webhooks/flute-v2-post-webhooks-delivery-logs-deliverylogid-retry","openApiOperationId":"flute-v2-post-webhooks-delivery-logs-deliveryLogId-retry","summary":"Retries a failed webhook delivery"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/api-reference/v2","description":"Mock server","isMockServer":true},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. Attempt retried.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/retrywebhookdeliveryisvresponsedto","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/retrywebhookdeliveryisvresponsedto","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/401/content/application~1json/example"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/404/content/application~1json/example"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/409/content/application~1json/example"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/retrywebhookdeliveryisvresponsedto","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/retrywebhookdeliveryisvresponsedto","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CommonExceptionExample","exampleIds":["paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/flute-v2-post-webhooks-delivery-logs-deliverylogid-retry"}],"panels":[]}]},"httpPath":"/v2/webhooks/delivery-logs/{deliveryLogId}/retry"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks are notifications that are automatically sent when specific predefined events occur."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks are commonly used, for instance, when payment processors need to notify a client that a charge succeeded or failed, when a subscription renews, or an incoming SMS message is available."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They replace polling."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This polling might have been:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Software polling for a status change either through a loop, or timed queries."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manually by a user explicitly polling expecting a response or pending status to be returned."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A merchant can only affect their own webhooks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They cannot view or modify other merchant's webhooks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Likewise, a partner can only affect merchants associated to them."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They cannot affect merchants of other partners."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required API Permissions"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required API Permission: Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Workflows"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create and manage Flute webhooks, use the following procedures and workflows."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1) Optionally, review all the valid event types."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks can accept one or more event types."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each event type is evaluated independently."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Selected events are not required to be related and may relate to different transaction types or workflows."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For organizational reasons, multiple webhooks can be created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each webhook can then have its own set of event types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list all available events, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/event-types"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2) Create the webhook"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create the webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/webhooks/endpoints"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3) Test the webhook"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify the endpoint is reachable (sends a test ping)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To test the webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/webhooks/endpoints/{webhookId}/ping"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following set of endpoints manage webhooks."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint provides a list of all available webhook for the merchant."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To list all the available webhooks, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/endpoints"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves webhook details specified by its webhookId."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve a specific webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/endpoints/{webhookId}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint provides an ability to update or change a webhook."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the set of event types may be changed without having to create a new webhook."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To modify or update a specific webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH /v2/webhooks/endpoints/{webhookId}"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint deletes the specific webhook."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This action can neither be undone nor can the webhook be retrieved."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This does not erase entries in the log file."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To delete a specific webhook, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/webhooks/endpoints/{webhookId}"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitoring Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following set of endpoints monitor webhooks."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These may be used to verify success of an attempt or assist in determining the cause of a problem."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists success level of delivery attempts."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view webhooks delivery attempts log file, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/delivery-logs"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint lists success level of delivery attempts for a specified webhook."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To view a specified webhook delivery attempts log file, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/delivery-logs/{webhookId}"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get full request/response detail for a single attempt"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint exports the delivery logs file."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It may be specified as either a CSV or JSON format."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To export webhooks delivery attempts log file, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/webhooks/delivery-logs/export"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retries a failed delivery."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retry a failed delivery, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v2/webhooks/delivery-logs/{id}/retry"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client Handling of Messages"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook sends a message to the URL specified by the client."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endpointUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST {{baseURL}}/v2/webhooks/endpoints"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message is considered successfully sent after a send confirmation is received."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If that send confirmation was not successfully confirmed, the message will be sent, or retried, a number of times before failing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After being successfully sent to the receiving endpoint or URL,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"it is the client's responsibility to handle it after that."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As a best practice, we recommend that the message is first verified to be from Flute."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, use HMAC verification."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This step greatly increases security and reduces system vulnerabilities such as spoofing, tampering, or data injection."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The IP address could be blocked to prevent future intrusions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once the sender is verified, the client can process the message as they need."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, code or an application on the receiving server may create an email or SMS message to send to the client."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/webhooks/endpoints","summary":"Lists webhook endpoints","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/flute-v2-get-webhooks-endpoints","deprecated":false},{"title":"/v2/webhooks/endpoints","summary":"Creates a webhook endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/flute-v2-post-webhooks-endpoints","deprecated":false},{"title":"/v2/webhooks/endpoints/{endpointId}","summary":"Retrieves a webhook endpoint by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/flute-v2-get-webhooks-endpoints-endpointid","deprecated":false},{"title":"/v2/webhooks/endpoints/{endpointId}","summary":"Updates a webhook endpoint","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/webhooks/flute-v2-patch-webhooks-endpoints-endpointid","deprecated":false},{"title":"/v2/webhooks/endpoints/{endpointId}","summary":"Deletes a webhook endpoint","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/flute-v2-delete-webhooks-endpoints-endpointid","deprecated":false},{"title":"/v2/webhooks/endpoints/{endpointId}/ping","summary":"Pings a webhook endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/flute-v2-post-webhooks-endpoints-endpointid-ping","deprecated":false},{"title":"/v2/webhooks/event-types","summary":"Lists webhook event types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/flute-v2-get-webhooks-event-types","deprecated":false},{"title":"/v2/webhooks/delivery-logs","summary":"Lists webhook delivery logs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/flute-v2-get-webhooks-delivery-logs","deprecated":false},{"title":"/v2/webhooks/delivery-logs/{deliveryLogId}","summary":"Retrieves a delivery log by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/flute-v2-get-webhooks-delivery-logs-deliverylogid","deprecated":false},{"title":"/v2/webhooks/delivery-logs/export","summary":"Exports webhook delivery logs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/flute-v2-get-webhooks-delivery-logs-export","deprecated":false},{"title":"/v2/webhooks/delivery-logs/{deliveryLogId}/retry","summary":"Retries a failed webhook delivery","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/flute-v2-post-webhooks-delivery-logs-deliverylogid-retry","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CommonExceptionExample":{"id":"components/schemas/CommonExceptionExample","kind":"json-schema","title":"CommonExceptionExample","data":{"type":"object","properties":{"details":{"type":"string","x-method":"response","nullable":true,"description":"Indicates details about the error.\n\nExample: Validation failed: -- Email: 'Email' is not a valid email address. Severity: Error\n","example":"Validation failed: -- Email: 'Email' is not a valid email address. Severity: Error"},"statusCode":{"type":"integer","format":"int32","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the HTTP response status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the HTTP status code returned by the attempted delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is a list of HTTP response status codes that include but are not limited to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery succeeded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint not found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limited"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 401"},"children":[]}]}]}],"example":401},"source":{"type":"string","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the source of the error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: <Service>"},"children":[]}]}]}],"example":"<Service>"},"exceptionType":{"type":"string","x-method":"response","nullable":true,"description":"Indicates the error's exception type.\n\nExample: FluentValidation.ValidationException\n","example":"FluentValidation.ValidationException"},"correlationId":{"type":"string","x-method":"response","nullable":true,"description":"Indicates the correlation identifier.\n\nExample: aa6cfcd0-0295-4a4c-b074-8c901f114fef\n","example":"aa6cfcd0-0295-4a4c-b074-8c901f114fef"},"entityId":{"type":"string","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the entity identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]},"errorCode":{"type":"string","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the error code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]},"title":{"type":"string","x-method":"response","nullable":true},"cause":{"type":"string","x-method":"response","nullable":true},"resolution":{"type":"string","x-method":"response","nullable":true},"documentationUrl":{"type":"string","x-method":"response","nullable":true,"description":"https://developer.flute.com/"}},"additionalProperties":false}},"components/schemas/customerId":{"id":"components/schemas/customerId","kind":"json-schema","title":"customerId","data":{"type":"string","format":"uuid","x-method":"response","nullable":true,"description":"Identifies the customer to link this payment method to.\n\nThis value may be null when this payment method is an orphan owned by the merchant directly.\nAn orphan payment method is a payment method in the merchant's vault but has no customer record associated with it.\n\nExample: 8fa8e727-73c6-436e-b56f-6f55aabf3b1c\n","example":"8fa8e727-73c6-436e-b56f-6f55aabf3b1c"}},"components/schemas/AddressDto":{"id":"components/schemas/AddressDto","kind":"json-schema","title":"AddressDto","data":{"type":"object","required":["countryCode"],"description":"Identifies the address information.\n","properties":{"addressLine1":{"type":"string","nullable":true,"x-method":"request","description":"Identifies the street address.\n\nExample: 21 E. Main Street\n","example":"21 E. Main Street"},"addressLine2":{"type":"string","nullable":true,"x-method":"request","description":"Identifies additional street address information.\n\nExample: Office 3\n","example":"Office 3"},"city":{"type":"string","x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the name of the city."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chicago"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New York"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Salt Lake City"},"children":[]}]}]}],"example":"Chicago"},"postalCode":{"type":"string","x-method":"request","minLength":2,"maxLength":15,"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the postal or ZIP code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"60601"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"60601-0001"},"children":[]}]}]}],"example":"60601-0001"},"stateCode":{"type":"string","nullable":true,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the state identifier (in two-letter USPS [United States Postal Service] postal code)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For regions outside the US, use the ISO 3166-2 format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TX"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WA"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IL"},"children":[]}]}]}],"example":"NY"},"countryCode":{"type":"string","nullable":true,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the country identifier (in two letter ISO 3166-1 format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CA"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GB"},"children":[]}]}]}],"example":"US"}},"additionalProperties":false}},"components/schemas/ListCustomersResponseDto":{"id":"components/schemas/ListCustomersResponseDto","kind":"json-schema","title":"ListCustomersResponseDto","data":{"type":"object","properties":{"customerId":{"$ref":"#/components/schemas/customerId"},"externalId":{"type":"string","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the external identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is used to detect duplicate transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a duplicate pending record is marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skipped"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: CUST-EXT-001"},"children":[]}]}]}],"example":"CUST-EXT-001"},"firstName":{"type":"string","x-method":"response","description":"Indicates the customer's first name.\n\nExample: Alexandro\n","example":"Alexandro","nullable":true},"lastName":{"type":"string","x-method":"response","description":"Indicates the customer's last name.\n\nExample: Peppared\n","example":"Peppared","nullable":true},"companyName":{"type":"string","x-method":"response","description":"Indicates the name of the customer's company or organization.\n\nExample: Peppared Street Cafe\n","example":"Peppared Street Cafe","nullable":true},"email":{"type":"string","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: peppared@example.com"},"children":[]}]}]}],"example":"peppared@example.com"},"mobilePhoneNumber":{"type":"string","x-method":"response","nullable":true,"format":"E.164","maxLength":20,"pattern":"^(null|\\+\\d{1,20})$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the customer's mobile phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: +14155552309"},"children":[]}]}]}],"example":"+14155552309"},"billingAddress":{"$ref":"#/components/schemas/AddressDto"},"lastTransactionDate":{"type":"string","format":"date-time","x-method":"response","nullable":true,"description":"Indicates the timestamp (in an ISO 8601 date-time UTC format) of the last transaction.\n\nExample: 2026-05-01T12:00:56.264Z\n","example":"2026-05-01T12:00:56.264Z"},"paymentMethodsCount":{"type":"integer","format":"int32","x-method":"response","description":"Indicates the number of payment methods.\n\nExample: 3\n","example":3}},"additionalProperties":false}},"components/schemas/pageInfo":{"id":"components/schemas/pageInfo","kind":"json-schema","title":"pageInfo","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates an object describing the pagination status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If additional pages to review are needed, repeat the exact same search but include a new pageIndex value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Typically, this will increment the current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageIndex"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by one."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, any valid value may be used."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value restrictions include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value less than zero is not permitted."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values equal to or greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end successfully but will not return any items."},"children":[]}]}]}]}],"properties":{"pageIndex":{"type":"integer","format":"int32","minimum":0,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the page number from the search results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pageIndex value is zero-based."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values range from zero to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" less one."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalPages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 10, then the valid range is zero to nine."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 0"},"children":[]}]}]}],"example":0},"pageSize":{"type":"integer","format":"int32","minimum":0,"maximum":200,"x-method":"response","description":"Indicates the number of items returned per page.\n\nExample: 20\n","example":20},"totalItems":{"type":"integer","format":"int32","x-method":"response","description":"Indicates the total number of items across all pages.\n\nExample: 1012\n","example":1012},"totalPages":{"type":"integer","format":"int32","x-method":"response","description":"Indicates the total number of pages available.\n\nExample: 51\n","example":51},"hasMore":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates additional pages are available after the current one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", additional pages are available after the current one."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", additional pages are not available after the current one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true}}}},"components/schemas/PageOfListCustomersResponseDto":{"id":"components/schemas/PageOfListCustomersResponseDto","kind":"json-schema","title":"PageOfListCustomersResponseDto","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"id":"get_v2_customers_response_body"}},"children":[]}]}]}],"properties":{"items":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/ListCustomersResponseDto"},"nullable":true},"pageInfo":{"$ref":"#/components/schemas/pageInfo"}},"additionalProperties":false}},"components/schemas/ValidationExceptionExample":{"id":"components/schemas/ValidationExceptionExample","kind":"json-schema","title":"ValidationExceptionExample","data":{"type":"object","properties":{"details":{"type":"string","x-method":"response","nullable":true,"description":"Indicates details about the error.\n\nExample: Validation failed: -- Email: 'Email' is not a valid email address. Severity: Error\n","example":"Validation failed: -- Email: 'Email' is not a valid email address. Severity: Error"},"statusCode":{"type":"integer","format":"int32","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the HTTP response status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the HTTP status code returned by the attempted delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is a list of HTTP response status codes that include but are not limited to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery succeeded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint not found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limited"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 401"},"children":[]}]}]}],"example":401},"source":{"type":"string","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the source of the error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: <Service>"},"children":[]}]}]}],"example":"<Service>"},"exceptionType":{"type":"string","x-method":"response","nullable":true,"description":"Indicates the error's exception type.\n\nExample: FluentValidation.ValidationException\n","example":"FluentValidation.ValidationException"},"correlationId":{"type":"string","x-method":"response","nullable":true,"description":"Indicates the correlation identifier.\n\nExample: aa6cfcd0-0295-4a4c-b074-8c901f114fef\n","example":"aa6cfcd0-0295-4a4c-b074-8c901f114fef"},"entityId":{"type":"string","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the entity identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]},"errorCode":{"type":"string","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the error code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]}]},"title":{"type":"string","x-method":"response","nullable":true},"cause":{"type":"string","x-method":"response","nullable":true},"resolution":{"type":"string","x-method":"response","nullable":true},"documentationUrl":{"type":"string","x-method":"response","nullable":true,"description":"https://developer.flute.com/"},"errors":{"type":"object","x-method":"response","additionalProperties":{"type":"array","items":{"type":"string"},"description":"Indicates the precise error.\n\nExample:\n","example":["Email"],"nullable":true},"nullable":true}},"additionalProperties":false}},"components/schemas/CustomerPaymentMethodCardDto":{"id":"components/schemas/CustomerPaymentMethodCardDto","kind":"json-schema","title":"CustomerPaymentMethodCardDto","data":{"type":"object","required":["cardNumber","expirationMonth","expirationYear"],"properties":{"paymentName":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the name for the payment method.\n\nThis is a free-formed name that is convenient for the merchant to recognize. \n\nExample: Peppared Street Cafe's Preferred Payment\n","example":"Peppared Street Cafe's Preferred Payment"},"cardNumber":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the card number.\n\nThis is the PAN (primary account number) for the transaction.\n\nExample: 411235455213655\n","example":"411235455213655"},"securityCode":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the securityCode (sometimes also called similarly to CCV) for the card.\n\nThis is a three or four digit security code on the credit card.\n\nExample: 483\n","example":"483"},"expirationMonth":{"type":"integer","format":"int32","x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the expiration month of the card (in 2-digit numeric format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"02"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12"},"children":[]}]}]}],"example":12},"expirationYear":{"type":"integer","format":"int32","x-method":"request","nullable":true,"description":"Specifies the expiration year of the card (in 4-digit YYYY format).\n\nExample: 2032\n","example":2032}},"additionalProperties":false}},"components/schemas/accountNumberRequest":{"id":"components/schemas/accountNumberRequest","kind":"json-schema","title":"accountNumberRequest","data":{"type":"string","nullable":true,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the bank account number for the ACH transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend avoiding the use of an account number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instead, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 1234567890"},"children":[]}]}]}],"example":"1234567890"}},"components/schemas/AccountHolderType":{"id":"components/schemas/AccountHolderType","kind":"json-schema","title":"AccountHolderType","data":{"enum":["Business","Personal"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the holder type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card issued to a business or company account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Personal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card issued to an individual for personal use."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Business"},"children":[]}]}]}],"example":"Business"}},"components/schemas/AccountType":{"id":"components/schemas/AccountType","kind":"json-schema","title":"AccountType","data":{"enum":["Checking","Savings"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the type of the account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checking"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account used for regular daily transactions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Savings"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account used to hold and grow funds over time."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Checking"},"children":[]}]}]}],"example":"Checking"}},"components/schemas/CustomerPaymentMethodAchDto":{"id":"components/schemas/CustomerPaymentMethodAchDto","kind":"json-schema","title":"CustomerPaymentMethodAchDto","data":{"type":"object","properties":{"paymentName":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the name for the payment method.\n\nThis is a free-formed name that is convenient for the merchant to recognize.\n\nExample: Peppared Street Cafe's Preferred Payment\n","example":"Peppared Street Cafe's Preferred Payment"},"routingNumber":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the ACH's account routing number.\n\nExample: 021000021\n","example":"021000021"},"accountNumber":{"$ref":"#/components/schemas/accountNumberRequest"},"taxId":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the tax identifier.\n\nExample: 12-3456789\n","example":"12-3456789"},"accountHolderType":{"$ref":"#/components/schemas/AccountHolderType"},"accountType":{"$ref":"#/components/schemas/AccountType"}},"additionalProperties":false}},"components/schemas/CreateCustomerRequestDto":{"id":"components/schemas/CreateCustomerRequestDto","kind":"json-schema","title":"CreateCustomerRequestDto","data":{"required":["firstName","lastName"],"type":"object","properties":{"firstName":{"minLength":1,"type":"string","x-method":"request","description":"Specifies the customer's first name.\n\nExample: Alexandro\n","example":"Alexandro"},"lastName":{"minLength":1,"type":"string","x-method":"request","description":"Specifies the customer's last name.\n\nExample: Peppared\n","example":"Peppared"},"companyName":{"type":"string","x-method":"request","description":"Specifies the name of the customer's company or organization.\n\nExample: Peppared Street Cafe\n","example":"Peppared Street Cafe","nullable":true},"email":{"type":"string","x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: peppared@example.com"},"children":[]}]}]}],"example":"peppared@example.com"},"mobilePhoneNumber":{"type":"string","x-method":"request","nullable":true,"format":"E.164","maxLength":20,"pattern":"^(null|\\+\\d{1,20})$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the customer's mobile phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: +14155552309"},"children":[]}]}]}],"example":"+14155552309"},"hasSmsConsent":{"type":"boolean","nullable":true,"default":false,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the customer has consented to receiving the SMS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer has consented to receiving the SMS."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer has not consented to receiving the SMS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"shouldUseBillingAsShippingAddress":{"type":"boolean","x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies to use the billing address as shipping address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the billing address as shipping address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", do not use the billing address as shipping address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"billingAddress":{"$ref":"#/components/schemas/AddressDto"},"shippingAddress":{"$ref":"#/components/schemas/AddressDto"},"paymentMethodsCards":{"type":"array","nullable":true,"x-method":"request","items":{"$ref":"#/components/schemas/CustomerPaymentMethodCardDto"},"description":"Specifies accepted cards (credit or debit) payment methods.\n"},"paymentMethodsAchAccounts":{"type":"array","nullable":true,"x-method":"request","items":{"$ref":"#/components/schemas/CustomerPaymentMethodAchDto"},"description":"Specifies accepted ACH accounts payment methods.\n"}},"additionalProperties":false}},"components/schemas/CreateCustomerResponseDto":{"id":"components/schemas/CreateCustomerResponseDto","kind":"json-schema","title":"CreateCustomerResponseDto","data":{"type":"object","properties":{"customerId":{"$ref":"#/components/schemas/customerId"}},"additionalProperties":false}},"components/schemas/paymentMethodIdResponse":{"id":"components/schemas/paymentMethodIdResponse","kind":"json-schema","title":"paymentMethodIdResponse","data":{"type":"string","format":"uuid","x-method":"request","nullable":true,"description":"Indicates the payment method identifier.\n\nThis is the identifier of a previously saved ACH account to charge.\n\nExample: 39a95e35-6d50-45ec-884b-c2417edf005d\n","example":"39a95e35-6d50-45ec-884b-c2417edf005d"}},"components/schemas/expirationMonthRequest":{"id":"components/schemas/expirationMonthRequest","kind":"json-schema","title":"expirationMonthRequest","data":{"type":"integer","format":"int32","nullable":true,"minimum":1,"maximum":12,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the expiration month (in a two-digit number format) of the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"07"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"12"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"example":12}},"components/schemas/expirationYearRequest":{"id":"components/schemas/expirationYearRequest","kind":"json-schema","title":"expirationYearRequest","data":{"type":"integer","format":"int32","nullable":true,"description":"Identifies the expiration year (in a four-digit number) of the card.\n\nExample: 2032\n","example":2032}},"components/schemas/TokenType":{"id":"components/schemas/TokenType","kind":"json-schema","title":"TokenType","data":{"enum":["Local","Network"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the type of the token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Local"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokenized and stored within Flute's own vault"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Network"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokenized through a card network, such as Visa or Mastercard, using their network tokenization services"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Local"},"children":[]}]}]}],"example":"Local"}},"components/schemas/CardType":{"id":"components/schemas/CardType","kind":"json-schema","title":"CardType","data":{"enum":["Unknown","Visa","MasterCard","AmericanExpress","DinersClub","Discover","JCB"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the type of the card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AmericanExpress"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card issued by American Express network."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DinersClub"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card issued by the Diners Club network."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discover"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card issued by the Discover network."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JCB"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card issued by the Japan Credit Bureau network."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MasterCard"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card issued by the MasterCard network."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card type could not be determined."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card issued by the Visa network."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Visa"},"children":[]}]}]}],"example":"Visa"}},"components/schemas/CreditDebitType":{"id":"components/schemas/CreditDebitType","kind":"json-schema","title":"CreditDebitType","data":{"enum":["Credit","Debit","Unknown"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the card is either credit or debit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card draws funds from a credit line."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card draws funds from a bank account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card funding type could not be determined."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Credit"},"children":[]}]}]}],"example":"Credit"}},"components/schemas/GetCustomerResponseDtoCardDto":{"id":"components/schemas/GetCustomerResponseDtoCardDto","kind":"json-schema","title":"GetCustomerResponseDtoCardDto","data":{"type":"object","properties":{"paymentMethodId":{"$ref":"#/components/schemas/paymentMethodIdResponse"},"paymentName":{"type":"string","x-method":"response","description":"Indicates the name of the payment method.\n\nThis is a free-formed name that is convenient to recognize.\n\nExample: Personal Visa\n","nullable":true,"example":"Personal Visa"},"isDefault":{"type":"boolean","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates this payment method is the default payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the card is the default payment method."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the card is not the default payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"cardMask":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the PAN (primary account number)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value may be partially obscured as additional security."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value can be safely displayed to clients without revealing the actual or full account number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: ************3655"},"children":[]}]}]}],"example":"************3655"},"expirationMonth":{"$ref":"#/components/schemas/expirationMonthRequest"},"expirationYear":{"$ref":"#/components/schemas/expirationYearRequest"},"cardTokenType":{"$ref":"#/components/schemas/TokenType"},"cardType":{"$ref":"#/components/schemas/CardType"},"creditDebitType":{"$ref":"#/components/schemas/CreditDebitType"}},"additionalProperties":false}},"components/schemas/GetCustomerResponseDtoAchAccountDto":{"id":"components/schemas/GetCustomerResponseDtoAchAccountDto","kind":"json-schema","title":"GetCustomerResponseDtoAchAccountDto","data":{"type":"object","properties":{"paymentMethodId":{"$ref":"#/components/schemas/paymentMethodIdResponse"},"paymentName":{"type":"string","x-method":"response","description":"Indicates the name for the payment method.\n\nThis is a free-formed name that is convenient for the merchant to recognize.\n\nExample: Peppared Street Cafe's Preferred Payment\n","example":"Peppared Street Cafe's Preferred Payment","nullable":true},"isDefault":{"type":"boolean","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates this payment method is the default payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this ACH account is the default payment method."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this ACH account is not the default payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"accountNumber":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the bank account number for the ACH transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value may be partially obscured as additional security."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It can then be safely displayed to clients without revealing the actual or full account number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1234567890"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"******7890"},"children":[]}]}]}],"example":"******7890"},"routingNumber":{"type":"string","x-method":"response","description":"Indicates the ACH's account routing number.\n\nExample: 021000021\n","example":"021000021","nullable":true},"accountType":{"$ref":"#/components/schemas/AccountType"},"accountHolderType":{"$ref":"#/components/schemas/AccountHolderType"},"taxId":{"type":"string","x-method":"response","description":"Indicates the tax identifier.\n\nExample: 12-3456789\n","example":"12-3456789","nullable":true}},"additionalProperties":false}},"components/schemas/GetCustomerResponseDto":{"id":"components/schemas/GetCustomerResponseDto","kind":"json-schema","title":"GetCustomerResponseDto","data":{"type":"object","properties":{"customerId":{"$ref":"#/components/schemas/customerId"},"externalId":{"type":"string","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the external identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is used to detect duplicate transactions."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a duplicate pending record is marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Skipped"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: CUST-EXT-12345"},"children":[]}]}]}],"nullable":true,"example":"CUST-EXT-12345"},"firstName":{"type":"string","x-method":"response","description":"Indicates the customer's first name.\n\nExample: Alexandro\n","example":"Alexandro","nullable":true},"lastName":{"type":"string","x-method":"response","description":"Indicates the customer's last name.\n\nExample: Peppared\n","example":"Peppared","nullable":true},"companyName":{"type":"string","x-method":"response","description":"Indicates the name of the customer's company or organization.\n\nExample: Peppared Street Cafe\n","example":"Peppared Street Cafe","nullable":true},"email":{"type":"string","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: peppared@example.com"},"children":[]}]}]}],"example":"peppared@example.com"},"mobilePhoneNumber":{"type":"string","x-method":"response","nullable":true,"format":"E.164","maxLength":20,"pattern":"^(null|\\+\\d{1,20})$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the customer's mobile phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: +14155552309"},"children":[]}]}]}],"example":"+14155552309"},"hasSmsConsent":{"type":"boolean","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the customer has consented to receiving the SMS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer has consented to receiving the SMS."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer has not consented to receiving the SMS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"shouldUseBillingAsShippingAddress":{"type":"boolean","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates to use the billing address as shipping address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the billing address as shipping address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", do not use the billing address as shipping address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"billingAddress":{"$ref":"#/components/schemas/AddressDto"},"shippingAddress":{"$ref":"#/components/schemas/AddressDto"},"transactionsCount":{"type":"integer","format":"int32","x-method":"response","description":"Indicates the number of transactions.\n\nExample: 31\n","example":31},"transactionsVolume":{"type":"number","format":"double","x-method":"response","description":"Indicates the sum of the transactions.\n\nExample: 1234.56\n","example":1234.56},"lastTransactionAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"response","nullable":true,"description":"Indicates the amount of the last transaction.\n\nExample: 99.99\n","example":99.99},"lastTransactionDate":{"type":"string","format":"date-time","x-method":"response","nullable":true,"description":"Indicates the date-time (in an ISO 8601 date-time format) of the last transaction.\n\nExample: 2026-05-01T12:00:56.264Z\n","example":"2026-05-01T12:00:56.264Z"},"numberOfSubscriptions":{"type":"integer","format":"int32","x-method":"response","description":"Indicates the number of active subscriptions.\n\nExample: 6\n","example":6},"cards":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/GetCustomerResponseDtoCardDto"},"description":"Indicates the card payment methods.\n","nullable":true},"achAccounts":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/GetCustomerResponseDtoAchAccountDto"},"description":"Indicates the ACH (automated clearing house) payment methods.\n","nullable":true}},"additionalProperties":false}},"components/schemas/UpdateCustomerRequestDto":{"id":"components/schemas/UpdateCustomerRequestDto","kind":"json-schema","title":"UpdateCustomerRequestDto","data":{"type":"object","properties":{"firstName":{"type":"string","x-method":"request","description":"Specifies the customer's first name.\n\nExample: Alexandro\n","example":"Alexandro","nullable":true},"lastName":{"type":"string","x-method":"request","description":"Specifies the customer's last name.\n\nExample: Peppared\n","example":"Peppared","nullable":true},"companyName":{"type":"string","x-method":"request","description":"Specifies the name of the customer's company or organization.\n\nExample: Peppared Street Cafe\n","example":"Peppared Street Cafe","nullable":true},"email":{"type":"string","x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: peppared@example.com"},"children":[]}]}]}],"example":"peppared@example.com"},"mobilePhoneNumber":{"type":"string","x-method":"request","nullable":true,"format":"E.164","maxLength":20,"pattern":"^(null|\\+\\d{1,20})$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the customer's mobile phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: +14155552309"},"children":[]}]}]}],"example":"+14155552309"},"hasSmsConsent":{"type":"boolean","nullable":true,"default":false,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the customer has consented to receiving the SMS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer has consented to receiving the SMS."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer has not consented to receiving the SMS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"shouldUseBillingAsShippingAddress":{"type":"boolean","x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies to use the billing address as shipping address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", use the billing address as shipping address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", do not use the billing address as shipping address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"billingAddress":{"$ref":"#/components/schemas/AddressDto"},"shippingAddress":{"$ref":"#/components/schemas/AddressDto"}},"additionalProperties":false}},"components/schemas/merchantId":{"id":"components/schemas/merchantId","kind":"json-schema","title":"merchantId","data":{"type":"string","format":"uuid","x-method":"REQUEST","description":"Identifies the merchant identifier.\n\nExample: 5611f824-48ef-4255-978d-91ce13953bbd\n","example":"5611f824-48ef-4255-978d-91ce13953bbd"}},"components/schemas/GetApiKeysResponseDtoApiKeyDto":{"id":"components/schemas/GetApiKeysResponseDtoApiKeyDto","kind":"json-schema","title":"GetApiKeysResponseDtoApiKeyDto","data":{"type":"object","properties":{"clientId":{"type":"string","description":"Indicates the client identifier.\n\nExample: 5c0f39f6-02a8-4053-9e72-56d9d5947c1c\n","format":"uuid","x-method":"response","example":"5c0f39f6-02a8-4053-9e72-56d9d5947c1c"},"merchantId":{"$ref":"#/components/schemas/merchantId"},"apiKeyName":{"type":"string","x-method":"response","description":"Indicates the display name for the API key.\n\nExample: Production integration key\n","nullable":true,"example":"Production integration key"}},"additionalProperties":false}},"components/schemas/GetApiKeysResponseDto":{"id":"components/schemas/GetApiKeysResponseDto","kind":"json-schema","title":"GetApiKeysResponseDto","data":{"type":"object","properties":{"apiKeys":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/GetApiKeysResponseDtoApiKeyDto"},"description":"An array of the merchant's API keys.","nullable":true}},"additionalProperties":false}},"components/schemas/CreateApiKeyRequestDto":{"id":"components/schemas/CreateApiKeyRequestDto","kind":"json-schema","title":"CreateApiKeyRequestDto","data":{"required":["apiKeyName","merchantId"],"type":"object","properties":{"merchantId":{"$ref":"#/components/schemas/merchantId"},"apiKeyName":{"minLength":1,"type":"string","x-method":"REQUEST","description":"Specifies a display name for the API key.\n\nExample: Production integration key\n","example":"Production integration key"}},"additionalProperties":false}},"components/schemas/CreateApiKeyResponseDto":{"id":"components/schemas/CreateApiKeyResponseDto","kind":"json-schema","title":"CreateApiKeyResponseDto","data":{"type":"object","properties":{"clientId":{"type":"string","description":"Indicates the client identifier.\n\nExample: 919c19ac-09cf-40c1-b093-413b9cabde43\n","format":"uuid","x-method":"response","example":"919c19ac-09cf-40c1-b093-413b9cabde43"},"clientSecret":{"type":"string","format":"UUID","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the client secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client secret is returned once and only during its creation here."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store it securely."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Protect the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientSecret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as if it were a password."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: bcaa0840-2872-44ea-9122-552a804a054a"},"children":[]}]}]}],"nullable":true,"example":"bcaa0840-2872-44ea-9122-552a804a054a"}},"additionalProperties":false}},"components/schemas/PaymentMethodType":{"id":"components/schemas/PaymentMethodType","kind":"json-schema","title":"PaymentMethodType","data":{"enum":["Card","ACH","Cash"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the payment method type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment made through an ACH bank transfer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment made with a credit or debit card."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment made with physical currency."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Card"},"children":[]}]}]}],"example":"Card"}},"components/schemas/PaymentMethodResponseDtoCardDetails":{"id":"components/schemas/PaymentMethodResponseDtoCardDetails","kind":"json-schema","title":"PaymentMethodResponseDtoCardDetails","data":{"type":"object","properties":{"cardMask":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the PAN (primary account number)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value may be partially obscured as additional security."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value can be safely displayed to clients without revealing the actual or full account number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: ************3655"},"children":[]}]}]}],"example":"************3655"},"expirationMonth":{"$ref":"#/components/schemas/expirationMonthRequest"},"expirationYear":{"$ref":"#/components/schemas/expirationYearRequest"},"cardTokenType":{"$ref":"#/components/schemas/TokenType"}},"additionalProperties":false}},"components/schemas/PaymentMethodResponseDtoAchDetails":{"id":"components/schemas/PaymentMethodResponseDtoAchDetails","kind":"json-schema","title":"PaymentMethodResponseDtoAchDetails","data":{"type":"object","properties":{"accountNumber":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the bank account number for the ACH transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value may be partially obscured as additional security."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It can then be safely displayed to clients without revealing the actual or full account number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1234567890"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"******7890"},"children":[]}]}]}],"example":"******7890"},"routingNumber":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the ACH (automated clearing house) account routing number.\n\nExample: 021000021\n","example":"021000021"},"accountType":{"$ref":"#/components/schemas/AccountType"},"accountHolderType":{"$ref":"#/components/schemas/AccountHolderType"},"taxId":{"type":"string","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the tax identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value may be partially obscured as additional security."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value can be safely displayed to clients without revealing the actual or full value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: **-***6789"},"children":[]}]}]}],"example":"**-***6789","nullable":true},"companyName":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the name of the customer's company or organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the ACH legal-entity name."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set on business orphan payment methods at create time so it is available at transaction time when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContactInfo.CompanyName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted on the request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Peppared Street Cafe"},"children":[]}]}]}],"example":"Peppared Street Cafe"}},"additionalProperties":false}},"components/schemas/PaymentMethodResponseDto":{"id":"components/schemas/PaymentMethodResponseDto","kind":"json-schema","title":"PaymentMethodResponseDto","data":{"type":"object","properties":{"paymentMethodId":{"$ref":"#/components/schemas/paymentMethodIdResponse"},"customerId":{"$ref":"#/components/schemas/customerId"},"name":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the name for the payment method.\n\nThis is a free-formed name that is convenient for the merchant to recognize.\n\nExample: Peppared Street Cafe's Preferred Payment\n","example":"Peppared Street Cafe's Preferred Payment"},"type":{"$ref":"#/components/schemas/PaymentMethodType"},"isDefault":{"type":"boolean","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates this payment method is the default payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is the default payment method."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is not the default payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"createdOn":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 UTC date-time format) the payment method was created on.\n\nExample: 2026-01-15T10:30:56.264Z\n","example":"2026-01-15T10:30:56.264Z"},"card":{"$ref":"#/components/schemas/PaymentMethodResponseDtoCardDetails"},"ach":{"$ref":"#/components/schemas/PaymentMethodResponseDtoAchDetails"}},"additionalProperties":false}},"components/schemas/PageOfPaymentMethodResponseDto":{"id":"components/schemas/PageOfPaymentMethodResponseDto","kind":"json-schema","title":"PageOfPaymentMethodResponseDto","data":{"type":"object","properties":{"items":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/PaymentMethodResponseDto"},"nullable":true},"pageInfo":{"$ref":"#/components/schemas/pageInfo"}},"additionalProperties":false}},"components/schemas/CreateCardPaymentMethodRequestDto":{"id":"components/schemas/CreateCardPaymentMethodRequestDto","kind":"json-schema","title":"CreateCardPaymentMethodRequestDto","data":{"type":"object","properties":{"cardNumber":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the credit card number used for the transaction.\n\nExample: 4111111111111111\n","example":"4111111111111111"},"securityCode":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the securityCode (sometimes also called similarly to CCV) for the card.\n\nThis is a three or four digit security code on the credit card.\n\nExample: 483\n","example":"483"},"expirationMonth":{"$ref":"#/components/schemas/expirationMonthRequest"},"expirationYear":{"$ref":"#/components/schemas/expirationYearRequest"},"customerId":{"$ref":"#/components/schemas/customerId"},"paymentName":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the name for the payment method.\n\nThis is a free-formed name that is convenient for the merchant to recognize.\n\nExample: Peppared Street Cafe's Preferred Payment\n","example":"Peppared Street Cafe's Preferred Payment"}},"additionalProperties":false}},"components/schemas/CreatePaymentMethodResponseDto":{"id":"components/schemas/CreatePaymentMethodResponseDto","kind":"json-schema","title":"CreatePaymentMethodResponseDto","data":{"type":"object","properties":{"paymentMethodId":{"$ref":"#/components/schemas/paymentMethodIdResponse"}},"additionalProperties":false}},"components/schemas/CreateAchPaymentMethodRequestDto":{"id":"components/schemas/CreateAchPaymentMethodRequestDto","kind":"json-schema","title":"CreateAchPaymentMethodRequestDto","data":{"type":"object","properties":{"routingNumber":{"type":"string","x-method":"request","description":"Specifies the ACH's account routing number.\n\nExample: 021000021\n","example":"021000021","nullable":true},"accountNumber":{"$ref":"#/components/schemas/accountNumberRequest"},"taxId":{"type":"string","x-method":"request","description":"Specifies the tax identifier.\n\nExample: 12-3456789\n","example":"12-3456789","nullable":true},"accountHolderType":{"$ref":"#/components/schemas/AccountHolderType"},"accountType":{"$ref":"#/components/schemas/AccountType"},"customerId":{"$ref":"#/components/schemas/customerId"},"name":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the name for the payment method.\n\nThis is a free-formed name that is convenient for the merchant to recognize.\n\nExample: Peppared Street Cafe's Preferred Payment\n","example":"Peppared Street Cafe's Preferred Payment"},"companyName":{"type":"string","x-method":"request","description":"Specifies the name of the customer's company or organization.\n\nThis is the legal entity name.\nRequired for orphan Business ACH transactions when the request does not supply it on the transaction's ContactInfo.\n","nullable":true,"example":"Acme Corp Inc"}},"additionalProperties":false}},"components/schemas/UpdatePaymentMethodRequestDto":{"id":"components/schemas/UpdatePaymentMethodRequestDto","kind":"json-schema","title":"UpdatePaymentMethodRequestDto","data":{"type":"object","properties":{"paymentName":{"type":"string","x-method":"request","description":"Specifies the name for the payment method.\n\nThis is a free-formed name that is convenient for the merchant to recognize.\n\nExample: Peppared Street Cafe's Preferred Payment\n","example":"Peppared Street Cafe's Preferred Payment","nullable":true}},"additionalProperties":false}},"components/schemas/SessionMode":{"id":"components/schemas/SessionMode","kind":"json-schema","title":"SessionMode","data":{"type":"string","enum":["Payment","SaveMethod","PaymentAndSave"],"format":"enum","default":"Payment","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the intent of the session."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard payment session."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SaveMethod"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vault-only session to store a payment method. The amount must be zero."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No payment is processed. This stores the customer's card details for future use. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vaultedPaymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned on the session once confirmed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PaymentAndSave"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charge the payment and store the customer's card details for future use."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vaultedPaymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned on the session once confirmed."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Payment"},"children":[]}]}]}],"example":"Payment"}},"components/schemas/CreatePaymentSessionRequestDto":{"id":"components/schemas/CreatePaymentSessionRequestDto","kind":"json-schema","title":"CreatePaymentSessionRequestDto","data":{"type":"object","description":"Request DTO for creating a payment session (v2).","additionalProperties":false,"required":["amount"],"properties":{"amount":{"type":"number","format":"double","minimum":0.01,"multipleOf":0.01,"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the base amount (in USD) to charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For payment sessions (mode of either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SaveMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentAndSave"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), this value must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For vault-only payment sessions (mode of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SaveMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), this value must be zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value of null creates a flexible-amount payment session where the amount is set at checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"64.99"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"example":64.99},"mode":{"$ref":"#/components/schemas/SessionMode"},"skipAddressVerification":{"type":"boolean","default":false,"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies to bypass the AVS (address verification service) in the payment gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is applicable only to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentAndSave"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", bypasses AVS in the payment gateway."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", does not bypass AVS in the payment gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"referenceId":{"type":"string","nullable":true,"x-method":"request","description":"Specifies a reference identifier provided by the merchant.\n\nThis is included in the duplicate-check key.\nIt allows the same card and amount combination to be charged multiple times when the reference identifiers are different.\n\nExample: 10001\n","example":"10001"},"tipAmount":{"type":"number","format":"double","nullable":true,"multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the absolute amount (in USD) of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 14.50 (for $14.50)"},"children":[]}]}]}],"example":14.5},"customerId":{"$ref":"#/components/schemas/customerId"},"successUrl":{"type":"string","nullable":true,"description":"Specifies the URL to redirect the payer to after a successful payment.\n\nThis value is not needed if using Flute Elements and Flute Checkout.\n\nExample: https://api.payments.flute.com/xOut/sessions/session-complete.html\n","example":"https://api.payments.flute.com/xOut/sessions/session-complete.html"},"paymentMethodTypes":{"type":"array","nullable":true,"items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies payment methods to be shown at checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit or debit card payment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH (automated clearing house) payment"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Card"},"children":[]}]}]}],"example":"Card"},"metadata":{"type":"object","nullable":true,"additionalProperties":{"type":"string","nullable":true},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies arbitrary key-value pairs to attach to the payment session object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These values are used to store supplemental information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They are not functionally used in this endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instead, they are included while retrieving the payment session."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows additional notes to be passed along to the operator."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass null to clear all metadata."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[ {\"orderId\": \"9921\"} ]"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[ {\"Guest notes\": \"Member of The World of Hyatt Credit Card.\"} ]"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[{\"orderId\": \"9921\"}, {\"Guest notes\": \"Member of The World of Hyatt Credit Card.}]"},"children":[]}]}]}],"example":[{"orderId":"9921"},{"Guest notes":"Member of The World of Hyatt Credit Card."}]},"afterCompletionMessage":{"type":"string","nullable":true,"description":"Specifies a message shown to the payer after the payment session completes.\n\nThis value is not needed if using Flute Elements and Flute Checkout.\n\nExample: Thank you for shopping with us.\n","example":"Thank you for shopping with us."},"isMultiUse":{"type":"boolean","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the checkout URL can be used for multiple payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is applied only if using Flute Elements or Flute Checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the checkout URL can be used for multiple payments."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the checkout URL cannot be used for multiple payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"expiresAt":{"type":"string","format":"date-time","nullable":true,"default":null,"description":"Specifies the date-time (in an ISO 8601 date-time format) expiration for the payment session.\n\nThe time must be in the future.\n\nIf this value is null or omitted, there is no expiration date.\n\nExample: 2027-02-19T20:24:52.934Z\n","example":"2027-02-19T20:24:52.934Z"},"pageName":{"type":"string","nullable":true,"description":"Specifies the display name shown on the checkout page.\n\nThis is a free-formed name that is convenient for the merchant to recognize. \n\nExample: Peppared Street Cafe's Preferred Payment\n","example":"Peppared Street Cafe's Preferred Payment"},"paymentNotes":{"type":"string","nullable":true,"description":"Specifies additional notes shown to the payer on the checkout page.\n\nExample: The client's server is being repaired.\n","example":"The client's server is being repaired."}}}},"components/schemas/CreatePaymentSessionResponseDto":{"id":"components/schemas/CreatePaymentSessionResponseDto","kind":"json-schema","title":"CreatePaymentSessionResponseDto","data":{"type":"object","description":"Response DTO for creating a payment session (v2).","additionalProperties":false,"properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the identifier of the created payment session."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is also called the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentSessionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SaveMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a payment session was successfully created but with an automatic "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That payment session is not available for additional processing."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The paymentSessionId may be used to retrieve the payment session information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For those details, see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/payment-sessions/{{paymentSessionId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the mode was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentAndSave"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a payment session was successfully created."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That payment session is available for additional processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: dce6a259-0a1b-4c2d-3e4f-5a6b7c8d9e25"},"children":[]}]}]}],"example":"dce6a259-0a1b-4c2d-3e4f-5a6b7c8d9e25"},"checkoutUrl":{"type":"string","nullable":true,"description":"Indicates full URL of the hosted checkout page for this payment session.\n\nExample: https://api.payments.flute.com/xOut/sessions/session-complete.html\n","example":"https://api.payments.flute.com/xOut/sessions/session-complete.html"},"checkoutUrlShort":{"type":"string","nullable":true,"description":"Indicates the shortened URL of the hosted checkout page for this payment session.\n\nExample: https://smallurl.com/4kxm9p2\n","example":"https://smallurl.com/4kxm9p2"}}}},"components/schemas/TransactionSourceResponseDto":{"id":"components/schemas/TransactionSourceResponseDto","kind":"json-schema","title":"TransactionSourceResponseDto","data":{"type":"object","description":"Transaction source information.","additionalProperties":false,"properties":{"name":{"type":"string","nullable":true,"description":"Indicates the name of that specific instance.\n\nThis is a free-formed type name that is convenient for the merchant to recognize.\n\nExample: Front Counter Terminal\n","example":"Front Counter Terminal"},"type":{"type":"string","nullable":true,"description":"Indicates the description of the source.\n\nThis is a free-formed type name that is convenient for the merchant to recognize.\n\nExample: Terminal\n","example":"Terminal"},"id":{"type":"string","format":"uuid","nullable":true,"description":"Indicates an identifier specifying the instance of the source.\n\nExample: 5e6e2ad1-8c9d-4e0f-1a2b-3c4d5e6f7a03\n","example":"5e6e2ad1-8c9d-4e0f-1a2b-3c4d5e6f7a03"},"typeId":{"type":"integer","format":"int32","nullable":true,"description":"Reserved for internal use only.\n\nDo not use.\n"},"version":{"type":"string","nullable":true,"x-method":"request","description":"Indicates the version.\n\nExample: 1.4.2\n","example":"1.4.2"}}}},"components/schemas/TransactionReceiptDtoTransactionReceiptAmountDto":{"id":"components/schemas/TransactionReceiptDtoTransactionReceiptAmountDto","kind":"json-schema","title":"TransactionReceiptDtoTransactionReceiptAmountDto","data":{"type":"object","additionalProperties":false,"properties":{"baseAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"request","description":"Specifies the base transaction amount before adjustments.\n\nExample: 99.99\n","example":99.99},"percentageOffAmount":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the discount amount (in USD) taken off."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This discount was calculated using the preset percentage from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentageOffRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 12.50"},"children":[]}]}]}],"example":12.5},"percentageOffRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the discount percentage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is percentage rate for the discount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This discount percentage calculates the discount amount for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentageOffAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 3.5 (as 3.5%)"},"children":[]}]}]}],"example":3.5},"cashDiscountAmount":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the cash discount amount (in USD) taken off."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 12.50 (for $12.50)"},"children":[]}]}]}],"example":12.5},"cashDiscountRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the discount percentage for a cash (or cash-equivalent) discount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 1.5 (for 1.5%)"},"children":[]}]}]}],"example":1.5},"surchargeAmount":{"type":"number","format":"double","x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the surcharge amount (in USD) applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 22 (for $22)"},"children":[]}]}]}],"example":22},"surchargeRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the percent of transaction surcharge amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is added to the base amount after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PercentageOffRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 2.5 (for 2.5%)"},"children":[]}]}]}],"example":2.5},"tipAmount":{"type":"number","multipleOf":0.01,"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the absolute amount (in USD) of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 14.50 (for $14.50)"},"children":[]}]}]}],"example":14.5},"tipRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates a percentage of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 18.50 (for 18.50%)"},"children":[]}]}]}],"example":18.5},"taxAmount":{"type":"number","format":"double","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the tax amount established on a product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 3.75 (for 3.75%)"},"children":[]}]}]}],"example":3.75},"taxRate":{"type":"number","format":"double","minimum":0,"maximum":22,"x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the default level 2 autoFill sales tax rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5.0 (for 5.0%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8.5 (for 8.5%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.25 (for 10.25%)"},"children":[]}]}]}],"example":8.5},"totalAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"request","description":"Indicates the final total amount (in USD).\n\nExample: 124.99\n","example":124.99}}}},"components/schemas/currencyCode":{"id":"components/schemas/currencyCode","kind":"json-schema","title":"currencyCode","data":{"type":"string","nullable":true,"default":"USD","x-method":"request/response","description":"Identifies the transaction's currency code (in ISO 4217 currency code).\n\nExample: USD\n","example":"USD"}},"components/schemas/paymentprocessorid":{"id":"components/schemas/paymentprocessorid","kind":"json-schema","title":"paymentprocessorid","data":{"type":"string","format":"uuid","nullable":true,"x-method":"request/response","description":"Identifies the payment processor.\n\nExample: 76215e54-a85b-4d42-9553-163fe393cb02\n","example":"76215e54-a85b-4d42-9553-163fe393cb02"}},"components/schemas/TransactionType":{"id":"components/schemas/TransactionType","kind":"json-schema","title":"TransactionType","data":{"type":"string","enum":["AchCancel","AchCredit","AchDebit","AchHold","AchRefund","AchUnHold","Authorization","Capture","CardAuthentication","Refund","RefundWORef","Sale","Settle","TipAdjustment","Void"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the type of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AchCancel"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a pending ACH transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AchCredit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends funds to a bank account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AchDebit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pulls funds from a bank account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AchHold"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Holds an ACH transaction temporarily."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AchRefund"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns funds from an ACH payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AchUnHold"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Releases a held ACH transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reserves funds for later capture."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capture"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collects funds from an authorization."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CardAuthentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirms cardholder identity before payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns funds from a transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RefundWORef"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunds a transaction without a reference."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorizes and captures funds together."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settle"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submits a batch for final processing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TipAdjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes the tip amount on a transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Void"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a transaction before settlement."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: AchDebit"},"children":[]}]}]}],"example":"AchDebit"}},"components/schemas/TransactionReceiptDtoTransactionReceiptSourceResponseDto":{"id":"components/schemas/TransactionReceiptDtoTransactionReceiptSourceResponseDto","kind":"json-schema","title":"TransactionReceiptDtoTransactionReceiptSourceResponseDto","data":{"type":"object","description":"Indicates an object describing the source of the transaction.\n","additionalProperties":false,"properties":{"name":{"type":"string","nullable":true,"description":"Indicates the name of that specific instance.\n\nThis is a free-formed type name that is convenient for the merchant to recognize.\n\nExample: Front Counter Terminal\n","example":"Front Counter Terminal"},"type":{"type":"string","nullable":true,"description":"Indicates the description of the source.\n\nThis is a free-formed type name that is convenient for the merchant to recognize.\n\nExample: Terminal\n","example":"Terminal"},"id":{"type":"string","format":"uuid","nullable":true,"description":"Indicates an identifier specifying the instance of the source.\n\nExample: 5e6e2ad1-8c9d-4e0f-1a2b-3c4d5e6f7a03\n","example":"5e6e2ad1-8c9d-4e0f-1a2b-3c4d5e6f7a03"},"typeId":{"type":"integer","format":"int32","nullable":true,"description":"Reserved for internal use only.\n\nDo not use.\n"}}}},"components/schemas/CardholderAuthenticationMethodDto":{"id":"components/schemas/CardholderAuthenticationMethodDto","kind":"json-schema","title":"CardholderAuthenticationMethodDto","data":{"type":"string","enum":["NotAuthenticated","PIN","ElectronicSignatureAnalysis","ManualSignature","ManualOther","Unknown","SystematicOther","ETicketEnvAmex","OfflinePin"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the method the cardholder was authenticated with."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ElectronicSignatureAnalysis"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Electronic signature captured and analyzed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ETicketEnvAmex"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"E-ticket environment specific to American Express."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ManualOther"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other manual verification method."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ManualSignature"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Paper or screen signature obtained."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NotAuthenticated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No cardholder verification performed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OfflinePin"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offline PIN verified by card chip, no network."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Online PIN verified by issuer."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SystematicOther"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Systematic or automated method not listed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unknown"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification method is unknown."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: PIN"},"children":[]}]}]}],"example":"PIN"}},"components/schemas/CardDataSourceDto":{"id":"components/schemas/CardDataSourceDto","kind":"json-schema","title":"CardDataSourceDto","data":{"type":"string","enum":["Internet","Swipe","NFC","EMV","EMVContactless","FallbackSwipe","Manual"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the source of the card (credit or debit)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMV"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Chip read using EMV tags."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EMVContactless"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tap chip read using EMV tags."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FallbackSwipe"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Swipe used after failed chip read."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internet"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Virtual terminal or API entry."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card present, keyed entry."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NFC"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contactless tap using EMV tags and track data."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Swipe"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Magnetic stripe track data read."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Swipe"},"children":[]}]}]}],"example":"Swipe"}},"components/schemas/TransactionReceiptDtoCardDetailsDto":{"id":"components/schemas/TransactionReceiptDtoCardDetailsDto","kind":"json-schema","title":"TransactionReceiptDtoCardDetailsDto","data":{"type":"object","additionalProperties":false,"properties":{"authCode":{"type":"string","nullable":true,"description":"Indicates the authorization code from the card processor.\n\nThis authorization does not apply to tip adjustments.\nThe code explicitly falls back to the original.\n\nExample: ABC123\n","example":"ABC123"},"mid":{"type":"string","nullable":true,"description":"Indicates the MID (merchant identifier).\n\nThis is an identifier the acquirer or processor assigns to a specific merchant account. \n\nExample: 700123456789\n","example":"700123456789"},"tid":{"type":"string","nullable":true,"description":"Indicates the TID (terminal identifier).\n\nThis is an identifier of the specific physical terminal or device used in the transaction.\n\nExample: 00012345\n","example":"00012345"},"rrn":{"type":"string","nullable":true,"description":"Indicates the RRN (retrieval reference number).\n\nThis is a card-network, such as for Visa or Mastercard, reference number assigned to every card transaction.\nIt is used to trace or retrieve the transaction later, such as for chargebacks or disputes.\n\nExample: 625031412345\n","example":"625031412345"},"cardCreditDebitType":{"$ref":"#/components/schemas/CreditDebitType"},"processCreditDebitType":{"$ref":"#/components/schemas/CreditDebitType"},"cardType":{"$ref":"#/components/schemas/CardType"}}}},"components/schemas/TransactionReceiptDtoElectronicCheckDetails":{"id":"components/schemas/TransactionReceiptDtoElectronicCheckDetails","kind":"json-schema","title":"TransactionReceiptDtoElectronicCheckDetails","data":{"type":"object","additionalProperties":false,"properties":{"customerAccountNumber":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the ACH account number.\n\nThis displays only the last four numbers.\n\nExample: 4111111111111111\n","example":"4111111111111111"},"customerRoutingNumber":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the ACH routing number.\n\nExample: 867320021\n","example":"867320021"},"accountHolderType":{"$ref":"#/components/schemas/AccountHolderType"},"accountType":{"$ref":"#/components/schemas/AccountType"},"taxId":{"type":"string","nullable":true,"description":"Specifies the tax identifier.\n\nExample: 12-3456789\n","example":"12-3456789"}}}},"components/schemas/SuggestedTipsDto":{"id":"components/schemas/SuggestedTipsDto","kind":"json-schema","title":"SuggestedTipsDto","data":{"type":"object","properties":{"tipPercent":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates a percentage of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 18.50 (for 18.50%)"},"children":[]}]}]}],"example":18.5},"tipAmount":{"type":"number","format":"double","multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the absolute amount (in USD) of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 14.50 (for $14.50)"},"children":[]}]}]}],"example":14.5}},"additionalProperties":false,"description":"Suggested tips information."}},"components/schemas/TransactionOperationDto":{"id":"components/schemas/TransactionOperationDto","kind":"json-schema","title":"TransactionOperationDto","data":{"type":"object","description":"Transaction operation information.","additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/TransactionType"},"availableAmount":{"type":"number","format":"double","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the maximum amount (in USD) eligible for the specified operation type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 49.99 (for $49.99)"},"children":[]}]}]}],"example":49.99},"suggestedTips":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SuggestedTipsDto"}}}}},"components/schemas/AvsActionsDto":{"id":"components/schemas/AvsActionsDto","kind":"json-schema","title":"AvsActionsDto","data":{"enum":["Allow","Deny"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates allowing an action after address verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If address verification passes, the payment proceeds."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deny"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If address verification does not pass, the payment is denied."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Allow"},"children":[]}]}]}],"example":"Allow"}},"components/schemas/AvsCodeGroupTypeDto":{"id":"components/schemas/AvsCodeGroupTypeDto","kind":"json-schema","title":"AvsCodeGroupTypeDto","data":{"enum":["NoMatch","PartialMatch","Incompatible","Unavailable","ValidGroup"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the AVS (address verification service) group type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incompatible"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The card issuer does not support this address check."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NoMatch"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing address and postal code did not match."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PartialMatch"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One part of the billing address matched, not both."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unavailable"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address check result was not available."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ValidGroup"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing address and postal code matched."},"children":[]}]}]}]}]}]}]}},"components/schemas/AvsResponseResultDto":{"id":"components/schemas/AvsResponseResultDto","kind":"json-schema","title":"AvsResponseResultDto","data":{"enum":["Passed","Failed"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the AVS (address verification service) result."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address check failed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address check passed."},"children":[]}]}]}]}]}]}]}},"components/schemas/AvsResponseDto":{"id":"components/schemas/AvsResponseDto","kind":"json-schema","title":"AvsResponseDto","data":{"type":"object","description":"Indicates the AVS (address verification service) response.","additionalProperties":false,"properties":{"action":{"$ref":"#/components/schemas/AvsActionsDto"},"responseCode":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the response code from processor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a simplified explanation of the result, see the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"codeDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Y"},"children":[]}]}]}],"example":"Y"},"codeDescription":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates a simplified explanation of the result."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the actual AVS (address verification service) result, see the field "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"responseCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Address and ZIP code match"},"children":[]}]}]}],"example":"Address and ZIP code match"},"group":{"$ref":"#/components/schemas/AvsCodeGroupTypeDto"},"result":{"$ref":"#/components/schemas/AvsResponseResultDto"}}}},"components/schemas/KeyValuePairOfStringAndString":{"id":"components/schemas/KeyValuePairOfStringAndString","kind":"json-schema","title":"KeyValuePairOfStringAndString","data":{"type":"object","properties":{"key":{"type":"string","nullable":true,"description":"Indicates the key of the pair.\n\nExample: ac\n","example":"ac"},"value":{"type":"string","nullable":true,"description":"Indicates the value of the pair.\n\nExample: 9F26\n","example":"9F26"}},"additionalProperties":false}},"components/schemas/TransactionReceiptDtoEmvTagsDto":{"id":"components/schemas/TransactionReceiptDtoEmvTagsDto","kind":"json-schema","title":"TransactionReceiptDtoEmvTagsDto","data":{"type":"object","additionalProperties":false,"properties":{"ac":{"type":"string","nullable":true,"description":"Indicates the AC (application cryptogram).\n\nThis is the cryptographic value generated by the card chip so the issuer can authenticate the transaction.\n\nExample: A123456789ABCDEF\n","example":"A123456789ABCDEF"},"tvr":{"type":"string","nullable":true,"description":"Indicates the TVR (terminal verification results).\n\nThis is a bitmask showing which checks the terminal ran and the success status of each one.\nThe individual checks include data authentication, cardholder verification, and risk management.\n\nExample: 0000008000\n","example":"0000008000"},"tsi":{"type":"string","nullable":true,"description":"Indicates the TSI (transaction status information).\n\nThis is a bitmask showing which processes were actually performed during the transaction.\n\nExample: E800\n","example":"E800"},"aid":{"type":"string","nullable":true,"description":"Indicates the AID (application identifier).\n\nThis identifies the specific card payment application on the chip, such as Visa Credit or Mastercard Debit.\n\nExample: A0000000031010\n","example":"A0000000031010"},"applicationLabel":{"type":"string","nullable":true,"description":"Indicates the application Label.\n\nThis is the human-readable name of that application, often shown on the terminal display.\n\nExample: VISA CREDIT\n","example":"VISA CREDIT"},"rawTags":{"description":"Indicates the EMV chip transaction data elements, or tags. \n\nEach data element is identified by its own hex tag number according to the EMV specifications.\nFor example, the five most commonly needed ones are: ac (9F26), tvr (95), tsi (9B), aid (4F), and applicationLabel (50).\nAn actual EMV transaction can return many more tags than that, sometimes with dozens of possible values.\n\nThis tag array object contains all the returned pairings.\n","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/KeyValuePairOfStringAndString"}}}}},"components/schemas/TransactionReceiptDto":{"id":"components/schemas/TransactionReceiptDto","kind":"json-schema","title":"TransactionReceiptDto","data":{"type":"object","description":"Transaction receipt information.","additionalProperties":false,"properties":{"transactionId":{"type":"string","format":"uuid","x-method":"response","nullable":true,"description":"Indicates the attached transaction identifier.\n\nThis value is available after processing.\n\nExample: f01339ec-8184-48c7-b58d-0780d6499ef4\n","example":"f01339ec-8184-48c7-b58d-0780d6499ef4"},"transactionDateTime":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 date-time format) of the transaction.\n\nExample: 2026-05-05T14:30:42.938Z\n","example":"2026-05-05T14:30:42.938Z"},"amount":{"$ref":"#/components/schemas/TransactionReceiptDtoTransactionReceiptAmountDto"},"currency":{"$ref":"#/components/schemas/currencyCode"},"processorId":{"$ref":"#/components/schemas/paymentprocessorid"},"processor":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the name of the payment processor.\n\nExample: TSYS\n","example":"TSYS"},"operationTypeId":{"type":"integer","format":"int32","description":"For internal use only.\n\nDo not use.\n"},"operationType":{"type":"string","default":"PayNow","enum":["PayNow","Subscription"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the type of the operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PayNow"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One-time charge for a service."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring charge for ongoing service."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: PayNow"},"children":[]}]}]}],"example":"PayNow"},"paymentMethodTypeId":{"type":"integer","format":"int32","description":"For internal use only.\n\nDo not use.\n"},"paymentMethodType":{"$ref":"#/components/schemas/PaymentMethodType"},"transactionTypeId":{"type":"integer","format":"int32","description":"For internal use only.\n\nDo not use.\n"},"transactionType":{"$ref":"#/components/schemas/TransactionType"},"customerId":{"$ref":"#/components/schemas/customerId"},"customerPan":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the masked card number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This displays only the last four numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: ************1111"},"children":[]}]}]}],"example":"************1111"},"cardTokenType":{"$ref":"#/components/schemas/TokenType"},"statusId":{"type":"integer","format":"int32","description":"For internal use only.\n\nDo not use.\n"},"status":{"type":"string","nullable":true,"enum":["Cancelled","Completed","Created","Failed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the status of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction was cancelled before completion."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment attempt finished processing. This does not mean the payment was approved — check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"responseCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"responseDescription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on this same object to confirm approval or decline."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction was initialized but not yet processed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment was attempted but did not succeed. A new session is needed."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Completed"},"children":[]}]}]}],"example":"Completed"},"merchantName":{"type":"string","x-method":"response","description":"Indicates the name of the customer's company or organization.\n\nExample: Peppared Street Cafe\n","example":"Peppared Street Cafe","nullable":true},"merchantAddress":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the customer's company address.\n\nExample: 123 Main St, Suite 100, New York\n","example":"123 Main St, Suite 100, New York"},"merchantPhoneNumber":{"type":"string","x-method":"response","nullable":true,"format":"E.164","maxLength":20,"pattern":"^(null|\\+\\d{1,20})$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the customer's phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: +14155552309"},"children":[]}]}]}],"example":"+14155552309"},"merchantEmailAddress":{"type":"string","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: peppared@example.com"},"children":[]}]}]}],"example":"peppared@example.com"},"merchantWebsite":{"type":"string","x-method":"response","nullable":true,"description":"Indicates the customer's URL.\n\nExample: PepparedStreetCafe.example.com\n","example":"PepparedStreetCafe.example.com"},"authCode":{"type":"string","nullable":true,"description":"Indicates the authorization code from the card processor.\n\nThis authorization does not apply to tip adjustments.\nThe code explicitly falls back to the original.\n\nExample: ABC123\n","example":"ABC123"},"source":{"$ref":"#/components/schemas/TransactionReceiptDtoTransactionReceiptSourceResponseDto"},"cardholderAuthenticationMethodId":{"$ref":"#/components/schemas/CardholderAuthenticationMethodDto"},"cardholderAuthenticationMethod":{"$ref":"#/components/schemas/CardholderAuthenticationMethodDto"},"cvmResultMsg":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates a message describing the CVM (cardholder verification method) the terminal attempted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It also indicates whether the verification succeeded or failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CVM Failed"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Signature Verified"},"children":[]}]}]}],"example":"Signature Verified"},"cardDataSourceId":{"type":"string","description":"For internal use only.\n\nDo not use.\n"},"cardDataSource":{"$ref":"#/components/schemas/CardDataSourceDto"},"responseCode":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the response code from processor."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"00"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"051"},"children":[]}]}]}],"example":"00"},"responseDescription":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates a human-readable message that explains the response and response code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved or completed successfully"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined - Do Not Honor"},"children":[]}]}]}],"example":"Declined - Do Not Honor"},"cardProcessingDetails":{"$ref":"#/components/schemas/TransactionReceiptDtoCardDetailsDto"},"achProcessingDetails":{"$ref":"#/components/schemas/TransactionReceiptDtoElectronicCheckDetails"},"availableOperations":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionOperationDto"}},"avsResponse":{"$ref":"#/components/schemas/AvsResponseDto"},"emvTags":{"$ref":"#/components/schemas/TransactionReceiptDtoEmvTagsDto"},"orderNumber":{"type":"string","nullable":true,"description":"Indicates a merchant-assigned order or invoice identifier associated to the transaction.\n\nExample: ORD-4521\n","example":"ORD-4521"}}}},"components/schemas/baseAmount":{"id":"components/schemas/baseAmount","kind":"json-schema","title":"baseAmount","data":{"type":"number","format":"double","nullable":true,"multipleOf":0.01,"minimum":0.01,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the base transaction amount (in USD) before adjustments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"125"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"125.5"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"125.50"},"children":[]}]}]}],"example":125.5}},"components/schemas/AmountDto":{"id":"components/schemas/AmountDto","kind":"json-schema","title":"AmountDto","data":{"type":"object","properties":{"baseAmount":{"$ref":"#/components/schemas/baseAmount"},"percentageOffAmount":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the discount amount (in USD) taken off."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This discount was calculated using the preset percentage from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentageOffRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 12.50"},"children":[]}]}]}],"example":12.5},"percentageOffRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the discount percentage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is percentage rate for the discount."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This discount percentage calculates the discount amount for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"percentageOffAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 3.5 (as 3.5%)"},"children":[]}]}]}],"example":3.5},"cashDiscountAmount":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the cash discount amount (in USD) taken off."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 12.50 (for $12.50)"},"children":[]}]}]}],"example":12.5},"cashDiscountRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the discount percentage for a cash (or cash-equivalent) discount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 1.5 (for 1.5%)"},"children":[]}]}]}],"example":1.5},"surchargeAmount":{"type":"number","format":"double","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the surcharge amount (in USD) applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 22 (for $22)"},"children":[]}]}]}],"example":22},"surchargeRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the percent of transaction amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is added to the base amount after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PercentageOffRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 2.5 (for 2.5%)"},"children":[]}]}]}],"example":2.5},"tipAmount":{"type":"number","multipleOf":0.01,"format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the absolute amount (in USD) of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 14.50 (for $14.50)"},"children":[]}]}]}],"example":14.5},"tipRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates a percentage of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 18.50 (for 18.50%)"},"children":[]}]}]}],"example":18.5},"taxAmount":{"type":"number","format":"double","x-method":"request/response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the tax amount established on a product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 3.75 (for 3.75%)"},"children":[]}]}]}],"example":3.75},"taxRate":{"type":"number","format":"double","minimum":0,"maximum":22,"x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the default level 2 autoFill sales tax rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5.0 (for 5.0%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8.5 (for 8.5%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.25 (for 10.25%)"},"children":[]}]}]}],"example":8.5},"totalAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"request","description":"Indicates the final total amount (in USD).\n\nExample: 124.99\n","example":124.99}}}},"components/schemas/GetPaymentSessionTransactionDetailsDto":{"id":"components/schemas/GetPaymentSessionTransactionDetailsDto","kind":"json-schema","title":"GetPaymentSessionTransactionDetailsDto","data":{"type":"object","properties":{"transactionReceiptUrl":{"type":"string","nullable":true,"description":"Indicates the direct URL link to the transaction receipt.\n\nExample: https://receipts.flute.com/r/90d084d6-55b8-4fb8-b658-861534d07f9a\n","example":"https://receipts.flute.com/r/90d084d6-55b8-4fb8-b658-861534d07f9a"},"transactionReceiptShortUrl":{"type":"string","nullable":true,"description":"Indicates the shortened direct URL link to the transaction receipt.\n\nExample: \"https://s.flute.com/745iZYxF83t\"\n","example":"https://s.flute.com/745iZYxF83t"},"source":{"$ref":"#/components/schemas/TransactionSourceResponseDto"},"transactionReceipt":{"$ref":"#/components/schemas/TransactionReceiptDto"},"id":{"type":"string","format":"uuid","description":"Indicates the payment method identifier.\n\nThis is the identifier of a previously saved ACH account to charge.\n\nExample: 39a95e35-6d50-45ec-884b-c2417edf005d\n","example":"39a95e35-6d50-45ec-884b-c2417edf005d"},"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"},"date":{"type":"string","format":"date-time","nullable":true,"description":"Indicates the date-time (in an ISO 8601 date-time format) of the transaction.\n\nExample: 2025-02-19T20:24:52.934Z\n","example":"2025-02-19T20:24:52.934Z"},"amount":{"$ref":"#/components/schemas/AmountDto"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"createdBy":{"type":"string","nullable":true,"description":"Indicates the creator of the transaction.\n\nExample: Alexandro Peppared\n","example":"Alexandro Peppared"},"merchant":{"type":"string","x-method":"response","description":"Indicates the name of the customer's company or organization.\n\nExample: Peppared Street Cafe\n","example":"Peppared Street Cafe","nullable":true},"processorId":{"$ref":"#/components/schemas/paymentprocessorid"},"processor":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the name of the payment processor.\n\nExample: TSYS\n","example":"TSYS"},"operationMode":{"$ref":"#/components/schemas/PaymentMethodType"},"paymentMethodType":{"$ref":"#/components/schemas/PaymentMethodType"},"paymentMethodName":{"type":"string","nullable":true,"description":"Indicates the name of the payment method.\n\nThis is a free-formed name that is convenient for the merchant to recognize.\n\nExample: Cafe Peppared Payments\n","example":"Cafe Peppared Payments"},"customerId":{"$ref":"#/components/schemas/customerId"},"customerName":{"type":"string","nullable":true,"description":"Indicates the name of the customer's company or organization.\n\nExample: Alexandro Peppared\n","example":"Alexandro Peppared"},"customerCompany":{"type":"string","nullable":true,"description":"Indicates the name of the customer's company or organization.\n\nExample: Peppared Street Cafe\n","example":"Peppared Street Cafe"},"customerPan":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the masked card number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This displays only the last four numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: ************1111"},"children":[]}]}]}],"example":"************1111"},"customerEmail":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: peppared@example.com"},"children":[]}]}]}],"example":"peppared@example.com"}}}},"components/schemas/GetPaymentSessionResponseDto":{"id":"components/schemas/GetPaymentSessionResponseDto","kind":"json-schema","title":"GetPaymentSessionResponseDto","data":{"type":"object","description":"Response DTO for getting payment session details.","additionalProperties":false,"properties":{"status":{"type":"string","nullable":true,"readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the payment session status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment session was initialized but not yet processed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment session was completed. Check transaction details to verify if the payment was approved or not."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment session was cancelled before completion."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment session expired before being completed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment was attempted but did not succeed. A new session must be created for a new payment attempt."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Created"},"children":[]}]}]}],"example":"Created"},"mode":{"$ref":"#/components/schemas/SessionMode"},"skipAddressVerification":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates to bypass the AVS (address verification service) in the payment gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is applicable only to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentAndSave"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", bypasses AVS in the payment gateway."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", does not bypass AVS in the payment gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"customerId":{"$ref":"#/components/schemas/customerId"},"vaultedPaymentMethodId":{"type":"string","format":"uuid","nullable":true,"description":"Indicates the identifier of the vaulted payment method when the session involves saving or using a stored payment method.\n\nExample: 990a65f4-519c-44f9-a615-fc9c7781190c\n","example":"990a65f4-519c-44f9-a615-fc9c7781190c"},"referenceId":{"type":"string","x-method":"response","nullable":true,"minLength":0,"maxLength":36,"description":"Indicates a reference identifier provided by the merchant.\n\nThis is included in the duplicate-check key.\nIt allows the same card and amount combination to be charged multiple times when the reference identifiers are different.\n\nExample: REF-EXT-12345\n","example":"REF-EXT-12345"},"tipAmount":{"type":"number","format":"double","nullable":true,"multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the absolute amount (in USD) of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 14.50 (for $14.50)"},"children":[]}]}]}],"example":14.5},"checkoutUrl":{"type":"string","nullable":true,"description":"Indicates full URL of the hosted checkout page for this payment session.\n\nExample: https://api.payments.flute.com/xOut/sessions/session-complete.html\n","example":"https://api.payments.flute.com/xOut/sessions/session-complete.html"},"checkoutUrlShort":{"type":"string","nullable":true,"description":"Indicates the shortened URL of the hosted checkout page for this payment session.\n\nExample: https://smallurl.com/4kxm9p2\n","example":"https://smallurl.com/4kxm9p2"},"successUrl":{"type":"string","nullable":true,"description":"Indicates the URL to redirect the payer to after a successful payment.\n\nThis value is not needed if using Flute Elements and Flute Checkout.\n\nExample: https://api.payments.flute.com/xOut/sessions/session-complete.html\n","example":"https://api.payments.flute.com/xOut/sessions/session-complete.html"},"paymentMethodTypes":{"type":"array","nullable":true,"items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates payment methods to be shown at checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit or debit card payment"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH (automated clearing house) payment"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Card"},"children":[]}]}]}],"example":"Card"},"metadata":{"type":"object","nullable":true,"additionalProperties":{"type":"string","nullable":true},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates arbitrary key-value pairs to attach to the payment session object."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These values are used to store supplemental information."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They are not functionally used in this endpoint."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instead, they are included while retrieving the payment session."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This allows additional notes to be passed along to the operator."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass null to clear all metadata."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[ {\"orderId\": \"9921\"} ]"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[ {\"Guest notes\": \"Member of The World of Hyatt Credit Card.\"} ]"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[{\"orderId\": \"9921\"}, {\"Guest notes\": \"Member of The World of Hyatt Credit Card.\"}]"},"children":[]}]}]}],"example":[{"orderId":"9921"},{"Guest notes":"Member of The World of Hyatt Credit Card."}]},"afterCompletionMessage":{"type":"string","nullable":true,"description":"Specifies a message shown to the payer after the payment session completes.\n\nThis value is not needed if using Flute Elements and Flute Checkout.\n\nExample: Thank you for shopping with us.\n","example":"Thank you for shopping with us."},"pageName":{"type":"string","nullable":true,"description":"Specifies the display name shown on the checkout page.\n\nThis is a free-formed name that is convenient for the merchant to recognize. \n\nExample: Peppared Street Cafe's Preferred Payment\n","example":"Peppared Street Cafe's Preferred Payment"},"isMultiUse":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the checkout URL can be used for multiple payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is applied only if using Flute Elements or Flute Checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the checkout URL can be used for multiple payments."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the checkout URL cannot be used for multiple payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"expiresAt":{"type":"string","format":"date-time","nullable":true,"description":"Specifies the expiration timestamp (in an ISO 8601 date-time UTC format) for the payment session.\n\nThe time must be in the future.\n\nExample: 2026-02-19T20:24:52.934Z\n","example":"2026-02-19T20:24:52.934Z"},"paymentNotes":{"type":"string","nullable":true,"description":"Specifies additional notes shown to the payer on the checkout page.\n\nExample: The client's server is being repaired.\n","example":"The client's server is being repaired."},"achAccountLast2":{"type":"string","nullable":true,"description":"Indicates the last two digits of an ACH (automated clearing house) bank account number.\n\nExample: 84\n","example":"84"},"achRoutingLast2":{"type":"string","nullable":true,"description":"Indicates the last two digits of an ACH (automated clearing house) bank routing number.\n\nExample: 62\n","example":"62"},"surchargeAmount":{"type":"number","format":"double","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the surcharge amount (in USD) applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 18.45 (for $18.45)"},"children":[]}]}]}],"example":18.45},"transactionDetails":{"$ref":"#/components/schemas/GetPaymentSessionTransactionDetailsDto"}}}},"components/schemas/PosDeviceId":{"id":"components/schemas/PosDeviceId","kind":"json-schema","title":"PosDeviceId","data":{"type":"string","minLength":1,"maxLength":36,"x-method":"response","nullable":true,"description":"Indicates the external POS terminal identifier.\n\nExample: POS-DEVICE-001\n","example":"POS-DEVICE-001"}},"components/schemas/PosTransactionStatus":{"id":"components/schemas/PosTransactionStatus","kind":"json-schema","title":"PosTransactionStatus","data":{"enum":["Cancelled","Completed","Failed","InProgress"],"type":"string","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the status of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POS transaction was canceled before it completed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POS transaction finished processing successfully."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POS transaction did not complete because of an error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InProgress"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POS transaction is still being processed."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Completed"},"children":[]}]}]}],"example":"Completed"}},"components/schemas/CaptureMethod":{"id":"components/schemas/CaptureMethod","kind":"json-schema","title":"CaptureMethod","data":{"enum":["Auto","Manual"],"type":"string","x-method":"request/response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the capture method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capture is the step that converts an authorization, funds reserved before a transaction, into an actual charge or funds captured for settlement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auto"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction is captured automatically at the same time as authorization or immediately after, with no separate action required."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manual"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction has been authorized. However, an explicit capture request must be made later to actually allocate the money."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken because if the transaction is never captured, the authorization simply expires and no funds move."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Auto"},"children":[]}]}]}],"example":"Auto"}},"components/schemas/processedAmount":{"id":"components/schemas/processedAmount","kind":"json-schema","title":"processedAmount","data":{"type":"number","format":"double","multipleOf":0.01,"x-method":"response","nullable":true,"description":"Indicates the transaction amount (in USD).\n\nThe value will be null until the transaction is completed.\n\nExample: 87.39\n","example":87.39}},"components/schemas/ExtraAmountsDto":{"id":"components/schemas/ExtraAmountsDto","kind":"json-schema","title":"ExtraAmountsDto","data":{"type":"object","description":"Identifies the extra amounts for the transaction.\n\nTo accept tips, the merchant is required to have tips enabled and tip-adjustment disabled.\nIf tip collection is enabled and committed at creation time, the tip gets prompted to the customer directly on the device.\n","properties":{"tipAmount":{"type":"number","format":"double","x-method":"request/response","nullable":true,"multipleOf":0.01,"minimum":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the absolute amount (in USD) of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the tip collection is enabled on the merchant settings and committed during POS transaction creation, the tip will be prompted to the customer directly on the device."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 14.50 (for $14.50)"},"children":[]}]}]}],"example":14.5},"tipRate":{"type":"number","format":"double","x-method":"request/response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies a tip percentage to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 18.50 (for 18.50%)"},"children":[]}]}]}],"example":18.5},"discountAmount":{"type":"number","format":"double","multipleOf":0.01,"minimum":0.01,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the absolute amount (in USD) of discount to be applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 25 (for $25)"},"children":[]}]}]}],"example":25},"discountRate":{"type":"number","format":"double","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies a percentage of a discount to be applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 5.5 (for 5.5%)"},"children":[]}]}]}],"example":5.5},"surchargeRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the percent of transaction amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 2.5 (for 2.5%)"},"children":[]}]}]}],"example":2.5}},"additionalProperties":false}},"components/schemas/ListPosTransactionsResponseDto":{"id":"components/schemas/ListPosTransactionsResponseDto","kind":"json-schema","title":"ListPosTransactionsResponseDto","data":{"type":"object","properties":{"posTransactionId":{"type":"string","format":"uuid","x-method":"response","description":"Indicates the POS transaction identifier.\n\nExample: 8be0aa51-eae6-4c30-a558-8579f3832f98\n","example":"8be0aa51-eae6-4c30-a558-8579f3832f98"},"createdOn":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 UTC date-time format) the POS payment was created on.\n\nExample: 2026-01-15T10:30:56.264Z\n","example":"2026-01-15T10:30:56.264Z"},"modifiedOn":{"type":"string","description":"Timestamp of the last POS transaction modification.","format":"date-time","example":"2026-05-05T14:31:15Z"},"merchantId":{"$ref":"#/components/schemas/merchantId"},"customerId":{"$ref":"#/components/schemas/customerId"},"terminalId":{"type":"string","format":"uuid","x-method":"response","description":"Indicates the identifier of terminal handling the POS transaction.\n\nExample: d0fc1606-47ea-464b-a31a-3971c9822d10\n","example":"d0fc1606-47ea-464b-a31a-3971c9822d10"},"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"},"posDeviceId":{"$ref":"#/components/schemas/PosDeviceId"},"referenceId":{"type":"string","x-method":"response","nullable":true,"minLength":0,"maxLength":36,"description":"Indicates a reference identifier provided by the merchant.\n\nThis is included in the duplicate-check key.\nIt allows the same card and amount combination to be charged multiple times when the reference identifiers are different.\n\nExample: REF-EXT-12345\n","example":"REF-EXT-12345"},"posTransactionStatus":{"$ref":"#/components/schemas/PosTransactionStatus"},"captureMethod":{"$ref":"#/components/schemas/CaptureMethod"},"transactionId":{"type":"string","format":"uuid","x-method":"response","nullable":true,"description":"Indicates the identifier of an attached transaction.\n\nThis value is available after processing.\n\nExample: a62fa6a1-8a2a-44f9-983d-c757017d4b66\n","example":"a62fa6a1-8a2a-44f9-983d-c757017d4b66"},"processedAmount":{"$ref":"#/components/schemas/processedAmount"},"baseAmount":{"$ref":"#/components/schemas/baseAmount"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"extraAmounts":{"$ref":"#/components/schemas/ExtraAmountsDto"}},"additionalProperties":false}},"components/schemas/PageOfListPosTransactionsResponseDto":{"id":"components/schemas/PageOfListPosTransactionsResponseDto","kind":"json-schema","title":"PageOfListPosTransactionsResponseDto","data":{"type":"object","properties":{"items":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/ListPosTransactionsResponseDto"},"nullable":true},"pageInfo":{"$ref":"#/components/schemas/pageInfo"}},"additionalProperties":false}},"components/schemas/PricingType":{"id":"components/schemas/PricingType","kind":"json-schema","title":"PricingType","data":{"enum":["Card","Cash"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the type of pricing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is only relevant when Dual Pricing is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction uses the card price, which may include a surcharge."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cash"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction uses the cash price, which may include a cash discount."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Card"},"children":[]}]}]}],"example":"Card"}},"components/schemas/PosTransactionReadingMethod":{"id":"components/schemas/PosTransactionReadingMethod","kind":"json-schema","title":"PosTransactionReadingMethod","data":{"enum":["KeyedEntry","Regular"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the POS terminal reading type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid Values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"KeyedEntry"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card details are entered manually on the terminal."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regular"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card details are read by the device, such as by tap, insert, or swipe."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Regular"},"children":[]}]}]}],"example":"Regular"}},"components/schemas/CreatePosTransactionRequestDto":{"id":"components/schemas/CreatePosTransactionRequestDto","kind":"json-schema","title":"CreatePosTransactionRequestDto","data":{"type":"object","required":["posDeviceId","baseAmount","currencyCode","terminalId","waitForAcceptanceByTerminal"],"properties":{"posDeviceId":{"type":"string","minLength":1,"maxLength":36,"x-method":"request","nullable":true,"description":"Specifies the external POS terminal identifier.\n\nExample: POS-DEVICE-001\n","example":"POS-DEVICE-001"},"baseAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the transaction amount (in USD)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\nRequired when the `TransactionType` is any of the following:\n"},"children":[]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capture"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RefundWORef"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund without reference"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TipAdjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"125"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"125.5"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"125.50"},"children":[]}]}]}],"example":125.5},"currencyCode":{"type":"string","nullable":true,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the transaction's currency code (in ISO 4217 currency code)."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\nRequired when the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"TransactionType"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is any of the following:\n"},"children":[]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capture"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RefundWORef"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund without reference"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TipAdjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: USD"},"children":[]}]}]}],"example":"USD"},"terminalId":{"type":"string","format":"uuid","x-method":"request","description":"Specifies the terminal identifier that handles the transaction.\n\nThe terminal must be in semi-integrated mode and available (online and ready).\nA semi-integrated terminal is one that is connected to a POS system, typically through a network or cable.\n\nExample: 0dfac966-9dbd-4608-a65f-d6a4c961dd35\n","example":"0dfac966-9dbd-4608-a65f-d6a4c961dd35"},"waitForAcceptanceByTerminal":{"type":"boolean","x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the response mode is either short or long polling."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", specifies long polling. HTTP response will be provided once the terminal accepts or declines to initiate the transaction or a timeout happens (terminal does not respond)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", specifies short polling. HTTP response will be returned immediately, while the terminal is still receiving the transaction request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After either case, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /v2/pos/transactions/{{posTransactionId}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve the latest information of the transaction submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Polling refers to how the POS application checks Flute for the status or result of a payment after initiating it."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The choice is mainly about how quickly the final transaction status is needed and how much repeated traffic can be tolerated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Short polling"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POS application repeatedly sends separate status requests at short intervals."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This checks for the completion status of the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each request gets an immediate response, and the POS application keeps asking until the transaction reaches a final state or times out."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Short polling is useful when the POS application can itself periodically check status instead of maintaining an open request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples include checking whether an earlier transaction eventually completed, recovering after a connection interruption, or reconciling a transaction whose final state is uncertain."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Long polling"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POS application sends a status request, and Flute holds that request open while waiting for the transaction state to change."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once there’s a result or the request times out, Flute responds."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POS application can then open another long-poll request if necessary."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Long polling is useful when the POS application is actively waiting for a transaction to complete."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, the customer has tapped their card and the POS application is waiting to show whether the payment was approved or declined."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request stays open until there’s a status change or timeout, so customers get a quick result without the application constantly making new requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"requestPaymentMethodStorageConsent":{"type":"boolean","default":false,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies displaying a message confirming saving the customer payment method information on the terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", display a message confirming saving the customer payment method."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", does not display a message confirming saving the customer payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"extraAmounts":{"$ref":"#/components/schemas/ExtraAmountsDto"},"referenceId":{"type":"string","x-method":"request","nullable":true,"minLength":0,"maxLength":36,"description":"Specifies a reference identifier provided by the merchant.\n\nThis is included in the duplicate-check key.\nIt allows the same card and amount combination to be charged multiple times when the reference identifiers are different.\n\nExample: REF-EXT-12345\n","example":"REF-EXT-12345"},"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"},"customerId":{"$ref":"#/components/schemas/customerId"},"pricingType":{"$ref":"#/components/schemas/PricingType"},"captureMethod":{"$ref":"#/components/schemas/CaptureMethod"},"readingMethod":{"$ref":"#/components/schemas/PosTransactionReadingMethod"}},"additionalProperties":false}},"components/schemas/AggregatedTransactionStatus":{"id":"components/schemas/AggregatedTransactionStatus","kind":"json-schema","title":"AggregatedTransactionStatus","data":{"enum":["Authorized","Captured","Voided","Refunded","Verified","Settled","PartiallyAuthorized","Informational","Scheduled","Cancelled","ChargedBack","InProgress","Cleared","Held","HeldByProcessor","Pending","Declined","Failed"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the aggregated transaction status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment approved but funds not yet captured."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction stopped before it completed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Captured"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved funds collected from the card."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ChargedBack"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cardholder disputed the charge with their bank."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cleared"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds finished processing and settled."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment rejected by the bank or processor."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction could not complete due to an error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Held"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction paused and awaiting release."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HeldByProcessor"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processor paused the transaction for review."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informational"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Record used for reference only, not a live charge."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InProgress"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction is still processing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PartiallyAuthorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only part of the requested amount was approved."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction is waiting for a result."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds returned to the cardholder."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction set to run at a future time."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds moved from issuer to the merchant account."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verified"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card or account confirmed as valid."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization cancelled before capture."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Authorized"},"children":[]}]}]}],"example":"Authorized"}},"components/schemas/TransactionDetailEventType":{"id":"components/schemas/TransactionDetailEventType","kind":"json-schema","title":"TransactionDetailEventType","data":{"enum":["Authorization","Sale","Capture","Void","Refund","TipAdjustment","CardAuthentication","Hold","UnHold","Credit","Settle"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the possible event types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorizes the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capture"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collects funds from an approved authorization."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CardAuthentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirms cardholder identity before payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends funds back to a cardholder outside a refund."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hold"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pauses a transaction or account temporarily."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns funds for a completed sale."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorizes and captures payment in one step."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settle"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submits a batch for final processing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TipAdjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds or changes a tip after the sale."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UnHold"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes a hold and resumes normal activity."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Void"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a transaction before it settles."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Capture"},"children":[]}]}]}],"example":"Capture"}},"components/schemas/referenceId":{"id":"components/schemas/referenceId","kind":"json-schema","title":"referenceId","data":{"type":"string","x-method":"response","nullable":true,"minLength":0,"maxLength":36,"description":"Indicates a reference identifier provided by the merchant.\n\nThis is included in the duplicate-check key.\nIt allows the same card and amount combination to be charged multiple times when the reference identifiers are different.\n\nExample: REF-EXT-12345\n","example":"REF-EXT-12345"}},"components/schemas/originalTransactionId":{"id":"components/schemas/originalTransactionId","kind":"json-schema","title":"originalTransactionId","data":{"type":"string","format":"uuid","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the original transaction identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value will be provided if the current transaction is a card refund."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise, it will be null or omitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 4d5d19c0-7b8c-4d9e-0f1a-2b3c4d5e6f92"},"children":[]}]}]}],"example":"4d5d19c0-7b8c-4d9e-0f1a-2b3c4d5e6f92"}},"components/schemas/AchSECCode":{"id":"components/schemas/AchSECCode","kind":"json-schema","title":"AchSECCode","data":{"enum":["Web","PPD","CCD"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the ACH SEC (standard entry class) code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CCD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for business to business payments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PPD"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for consumer payments like payroll or bill pay."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for a payment authorized on a website."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: CCD"},"children":[]}]}]}],"example":"CCD"}},"components/schemas/processorDetails":{"id":"components/schemas/processorDetails","kind":"json-schema","title":"processorDetails","data":{"type":"object","properties":{"mid":{"type":"string","nullable":true,"description":"Indicates the MID (merchant identifier) assigned by the processor.\n\nExample: 932129304958123\n","example":932129304958123},"tid":{"type":"string","nullable":true,"description":"Indicates the TID (terminal identifier) assigned by the processor.\n\nexample: 6095275263\n","example":6095275263},"authCode":{"type":"string","nullable":true,"description":"Indicates the authorization code returned by the processor.\n\nExample: VTLMC1\n","example":"VTLMC1"},"rrn":{"type":"string","nullable":true,"description":"Indicates the RRN (retrieval reference number) returned by the processor.\n\nExample: 59d5df1aa58d4de3969175eeece571c1\n","example":"59d5df1aa58d4de3969175eeece571c1"}},"additionalProperties":false,"description":"Payment processor identifiers for a transaction."}},"components/schemas/TransactionAddressVerificationServiceResponseDto":{"id":"components/schemas/TransactionAddressVerificationServiceResponseDto","kind":"json-schema","title":"TransactionAddressVerificationServiceResponseDto","data":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/AvsActionsDto"},"responseCode":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the AVS (address verification service) response code from processor.\n\nExample: A\n","example":"Y"},"description":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the description of the AVS (address verification service) result code description.\n\nExample: Address and ZIP match\n","example":"Address and ZIP match"}},"additionalProperties":false,"description":"Indicates the AVS (address verification service) response for card payments."}},"components/schemas/TransactionStatus":{"id":"components/schemas/TransactionStatus","kind":"json-schema","title":"TransactionStatus","data":{"enum":["Pending","Approved","Declined","Failed"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the transaction status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment passed checks. Funds will move."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank or card issuer rejected payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment attempt ended in error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment is waiting for a result."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Approved"},"children":[]}]}]}],"example":"Approved"}},"components/schemas/linkedTransaction":{"id":"components/schemas/linkedTransaction","kind":"json-schema","title":"linkedTransaction","data":{"type":"object","description":"Indicates an object detailing the related POS transaction.\n\nThis value will be null until the transaction is completed.\n","properties":{"transactionId":{"type":"string","format":"uuid","x-method":"response","nullable":true,"description":"Indicates the attached transaction identifier.\n\nThis value is available after processing.\n\nExample: f01339ec-8184-48c7-b58d-0780d6499ef4\n","example":"f01339ec-8184-48c7-b58d-0780d6499ef4"},"transactionDateTime":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the timestamp (in an ISO 8601 date-time format) of the transaction.\n\nExample: 2026-05-05T14:30:42.938Z\n","example":"2026-05-05T14:30:42.938Z"},"transactionStatus":{"$ref":"#/components/schemas/AggregatedTransactionStatus"},"transactionType":{"$ref":"#/components/schemas/TransactionDetailEventType"},"cardTokenType":{"$ref":"#/components/schemas/TokenType"},"paymentMethodType":{"$ref":"#/components/schemas/PaymentMethodType"},"referenceId":{"$ref":"#/components/schemas/referenceId"},"originalTransactionId":{"$ref":"#/components/schemas/originalTransactionId"},"processedAmount":{"$ref":"#/components/schemas/processedAmount"},"refundDetails":{"type":"object","properties":{"refundedAmount":{"type":"number","format":"double","multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the total amount (in USD) already refunded against this transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"56.99"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]}],"example":0},"availableRefundAmount":{"type":"number","format":"double","multipleOf":0.01,"description":"Indicates the amount (in USD) still refundable.\n\nExample: 120.99\n","example":120.99},"isFullyRefunded":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the amount has been fully refunded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the amount has been fully refunded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the amount has not been fully refunded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true}},"additionalProperties":false,"description":"Indicates an object detailing the refund posture for a transaction that can be refunded.\n\nThis value is null on transactions that are themselves refunds or credits.\nThose cannot be refunded again.\n"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"pricingType":{"$ref":"#/components/schemas/PricingType"},"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"},"customerId":{"$ref":"#/components/schemas/customerId"},"merchantId":{"$ref":"#/components/schemas/merchantId"},"batchId":{"type":"string","format":"uuid","x-method":"response","nullable":true,"description":"Indicates the batch settlement identifier.\n\nExample: 42df0a13-4bf4-48f8-929c-08a379c0a0d6\n","example":"42df0a13-4bf4-48f8-929c-08a379c0a0d6"},"amountBreakdown":{"type":"object","properties":{"baseAmount":{"$ref":"#/components/schemas/baseAmount"},"tipAmount":{"type":"number","format":"double","nullable":true,"multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the absolute amount (in USD) of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 14.50 (for $14.50)"},"children":[]}]}]}],"example":14.5},"tipRate":{"type":"number","format":"double","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates a percentage of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 18.50 (for 18.50%)"},"children":[]}]}]}],"example":18.5},"surchargeAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the surcharge amount (in USD) applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 22 (for $22)"},"children":[]}]}]}],"example":22},"surchargeRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the percent of transaction amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is added to the base amount after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PercentageOffRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 2.5 (for 2.5%)"},"children":[]}]}]}],"example":2.5},"discountAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the absolute amount (in USD) of discount to be applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This does not include ZCP (zero cost processing) cash-discount amounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 25 (for $25)"},"children":[]}]}]}],"example":25},"discountRate":{"type":"number","format":"double","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates a percentage of a discount to be applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This does not include ZCP (zero cost processing) cash-discount amounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 5.5 (for 5.5%)"},"children":[]}]}]}],"example":5.5}},"additionalProperties":false,"description":"Indicates an object detailing the amount breakdown details.\n"},"cardDetails":{"type":"object","description":"Indicates an object detailing card details exposed on transaction responses (masked or non-sensitive fields only).\n","properties":{"paymentMethodId":{"$ref":"#/components/schemas/paymentMethodIdResponse"},"maskedCardNumber":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the masked card number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This displays only the last four numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: ************1111"},"children":[]}]}]}],"example":"************1111"},"cardBrand":{"$ref":"#/components/schemas/CardType"},"cardType":{"$ref":"#/components/schemas/CreditDebitType"},"cardProcessedAsType":{"$ref":"#/components/schemas/CreditDebitType"},"cardDataSource":{"$ref":"#/components/schemas/CardDataSourceDto"},"cardholderVerificationMethod":{"$ref":"#/components/schemas/CardholderAuthenticationMethodDto"},"emvTags":{"$ref":"#/components/schemas/TransactionReceiptDtoEmvTagsDto"}},"additionalProperties":false},"achDetails":{"type":"object","properties":{"paymentMethodId":{"$ref":"#/components/schemas/paymentMethodIdResponse"},"maskedAccountNumber":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the masked ACH account number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This displays only the last four numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: ************1111"},"children":[]}]}]}],"example":"************1111"},"accountRoutingNumber":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the ACH's account routing number.\n\nExample: 021000021\n","example":"021000021"},"accountHolderType":{"$ref":"#/components/schemas/AccountHolderType"},"accountType":{"$ref":"#/components/schemas/AccountType"},"secCode":{"$ref":"#/components/schemas/AchSECCode"},"isSameDayProcessing":{"type":"boolean","nullable":true,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates same-day ACH processing for faster settlement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the transaction uses the same-day ACH processing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the transaction does not use the same-day ACH processing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null or omitted, the default standard ACH processing is used.."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"requesterIpAddress":{"maxLength":45,"minLength":0,"type":"string","x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the IP address of the end user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid IP address formats are:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IPv4"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IPv6 format3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This end user may be the customer, operator, or application responsible for submitting the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is required for audit and fraud-detection purposes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 192.168.1.1"},"children":[]}]}]}],"example":"192.168.1.1"}},"additionalProperties":false,"description":"ACH account details exposed on transaction responses (masked or non-sensitive fields only)."},"processorDetails":{"$ref":"#/components/schemas/processorDetails"},"declineDetails":{"type":"object","description":"Indicates an object detailing a declined or failed transaction.\nThis value is null when the transaction was approved or is pending.\n","properties":{"code":{"type":"string","nullable":true,"description":"Indicates the decline or failure code from the processor or gateway.\n\nExample: 41\n","example":41},"message":{"type":"string","nullable":true,"description":"Indicates a human-readable decline or failure message.\n\nExample: HOLD-CALL\n","example":"HOLD-CALL"}},"additionalProperties":false},"addressVerificationServiceResponse":{"$ref":"#/components/schemas/TransactionAddressVerificationServiceResponseDto"},"transactionEvents":{"type":"array","items":{"type":"object","properties":{"type":{"enum":["Authorization","Sale","Capture","Void","Refund","TipAdjustment","CardAuthentication","Hold","UnHold","Credit","Settle"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the transaction types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction reserved funds for a later capture."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CardAuthentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction confirmed the identity of the cardholder."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capture"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction collected funds from an earlier authorization."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction sent funds to the payment method without a prior charge."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hold"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction placed a temporary hold on funds."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction returned funds from an earlier charge."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction authorized and captured funds together."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settle"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction submitted a batch for final processing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TipAdjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction changed the tip amount on a prior charge."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UnHold"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction released a prior hold on funds."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Void"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction canceled a charge before settlement."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Credit"},"children":[]}]}]}],"example":"Credit"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"amount":{"type":"number","format":"double","minimum":0.01,"multipleOf":0.01,"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the base amount (in USD) to charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For payment sessions (mode of either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SaveMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PaymentAndSave"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), this value must be greater than zero."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For vault-only payment sessions (mode of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SaveMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), this value must be zero."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value of null creates a flexible-amount payment session where the amount is set at checkout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"64.99"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]}],"example":64.99},"dateTime":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 date-time format) of the event.\n\nExample: 2026-05-05T14:30:42.938Z\n","example":"2026-05-05T14:30:42.938Z"},"originalTransactionId":{"$ref":"#/components/schemas/originalTransactionId"},"declineDetails":{"type":"object","description":"Indicates an object detailing a declined or failed transaction.\nThis value is null when the transaction was approved or is pending.\n","properties":{"code":{"type":"string","nullable":true,"description":"Indicates the decline or failure code from the processor or gateway.\n\nExample: 41\n","example":41},"message":{"type":"string","nullable":true,"description":"Indicates a human-readable decline or failure message.\n\nExample: HOLD-CALL\n","example":"HOLD-CALL"}},"additionalProperties":false}},"additionalProperties":false}},"source":{"type":"object","description":"Indicates an object describing the origination of the transaction.\n","properties":{"sourceType":{"enum":["Portal","ApiKey","Terminal","Invoice","QuickPayment","WebComponent","Subscription","MobileApp","TapToPay"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the source of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ApiKey"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external application created the transaction using an API key."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A billed invoice created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MobileApp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A mobile application created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A staff member created the transaction through the web portal."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QuickPayment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A one-time payment link created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A recurring subscription created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TapToPay"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A mobile device using tap to pay created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A physical payment terminal created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WebComponent"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An embedded web component created the transaction."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: QuickPayment"},"children":[]}]}]}],"example":"QuickPayment"},"sourceId":{"type":"string","format":"uuid","nullable":true,"description":"Indicates the Identifier of the originating entity.\n\nExample: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"sourceName":{"type":"string","nullable":true,"description":"Indicates a human-readable name of the originator.\n\nExample: API Key for ecommerce app\n","example":"API Key for ecommerce app"}},"additionalProperties":false}}}},"components/schemas/CreatePosTransactionResponseDto":{"id":"components/schemas/CreatePosTransactionResponseDto","kind":"json-schema","title":"CreatePosTransactionResponseDto","data":{"type":"object","properties":{"posTransactionId":{"type":"string","format":"uuid","x-method":"response","description":"Indicates the POS transaction identifier.\n\nExample: f77b4b4d-2f35-4cd2-8631-31318a4713a1\n","example":"f77b4b4d-2f35-4cd2-8631-31318a4713a1"},"posTransactionStatus":{"$ref":"#/components/schemas/PosTransactionStatus"},"createdOn":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 UTC date-time format) the POS transaction was created on.\n\nExample: 2026-01-15T10:30:56.264Z\n","example":"2026-01-15T10:30:56.264Z"},"modifiedOn":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 UTC date-time format) when the POS transaction was last updated.\n\nExample: 2026-03-16T16:32:58.743Z\n","example":"2026-03-16T16:32:58.743Z"},"merchantId":{"$ref":"#/components/schemas/merchantId"},"customerId":{"$ref":"#/components/schemas/customerId"},"terminalId":{"type":"string","format":"uuid","x-method":"response","description":"Indicates the terminal identifier that handles the transaction.\n\nThe terminal must be in semi-integrated mode and available (online and ready).\nA semi-integrated terminal is one that is connected to a POS system, typically through a network or cable.\n\nExample: 0dfac966-9dbd-4608-a65f-d6a4c961dd35\n","example":"0dfac966-9dbd-4608-a65f-d6a4c961dd35"},"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"},"posDeviceId":{"$ref":"#/components/schemas/PosDeviceId"},"referenceId":{"type":"string","description":"External Reference ID","nullable":true,"example":"REF-EXT-12345"},"captureMethod":{"$ref":"#/components/schemas/CaptureMethod"},"transactionId":{"type":"string","format":"uuid","x-method":"response","nullable":true,"description":"Indicates the attached transaction identifier.\n\nThis value is available after processing.\n\nExample: f01339ec-8184-48c7-b58d-0780d6499ef4\n","example":"f01339ec-8184-48c7-b58d-0780d6499ef4"},"baseAmount":{"$ref":"#/components/schemas/baseAmount"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"extraAmounts":{"$ref":"#/components/schemas/ExtraAmountsDto"},"processedAmount":{"$ref":"#/components/schemas/processedAmount"},"linkedTransaction":{"$ref":"#/components/schemas/linkedTransaction"}},"additionalProperties":false}},"components/schemas/GetPosTransactionResponseDto":{"id":"components/schemas/GetPosTransactionResponseDto","kind":"json-schema","title":"GetPosTransactionResponseDto","data":{"type":"object","properties":{"posTransactionId":{"type":"string","format":"uuid","x-method":"response","description":"Indicates the POS transaction identifier.\n\nExample: 201cc2fb-d9bd-4cc6-a254-b913f9a6b358\n","example":"201cc2fb-d9bd-4cc6-a254-b913f9a6b358"},"createdOn":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 UTC date-time format) the POS payment method was created on.\n\nExample: 2026-01-15T10:30:56.264Z\n","example":"2026-01-15T10:30:56.264Z"},"modifiedOn":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 UTC date-time format) the POS payment method was last modified on.\n\nExample: 2026-03-15T10:30:56.264Z\n","example":"2026-01-15T10:30:56.264Z"},"merchantId":{"$ref":"#/components/schemas/merchantId"},"customerId":{"$ref":"#/components/schemas/customerId"},"terminalId":{"type":"string","format":"uuid","x-method":"response","description":"Indicates the terminal identifier handling the POS transaction.\n\nExample: 9e617a7e-5a7b-415f-abbb-8df16dd2e64f\n","example":"9e617a7e-5a7b-415f-abbb-8df16dd2e64f"},"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"},"posDeviceId":{"$ref":"#/components/schemas/PosDeviceId"},"referenceId":{"type":"string","x-method":"response","nullable":true,"minLength":0,"maxLength":36,"description":"Indicates a reference identifier provided by the merchant.\n\nThis is included in the duplicate-check key.\nIt allows the same card and amount combination to be charged multiple times when the reference identifiers are different.\n\nExample: REF-EXT-12345\n","example":"REF-EXT-12345"},"posTransactionStatus":{"$ref":"#/components/schemas/PosTransactionStatus"},"captureMethod":{"$ref":"#/components/schemas/CaptureMethod"},"transactionId":{"type":"string","format":"uuid","x-method":"response","nullable":true,"description":"Indicates the attached transaction identifier.\n\nThis value is available after processing.\n\nExample: f01339ec-8184-48c7-b58d-0780d6499ef4\n","example":"f01339ec-8184-48c7-b58d-0780d6499ef4"},"baseAmount":{"$ref":"#/components/schemas/baseAmount"},"processedAmount":{"$ref":"#/components/schemas/processedAmount"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"extraAmounts":{"$ref":"#/components/schemas/ExtraAmountsDto"},"linkedTransaction":{"$ref":"#/components/schemas/linkedTransaction"}},"additionalProperties":false}},"components/schemas/PrintTransactionReceiptRequestDto":{"id":"components/schemas/PrintTransactionReceiptRequestDto","kind":"json-schema","title":"PrintTransactionReceiptRequestDto","data":{"type":"object","properties":{"terminalId":{"type":"string","format":"uuid","x-method":"request","description":"Specifies the terminal identifier for the terminal initiating transaction receipt print request.\n\nThe terminal must be in semi-integrated mode and available (online and ready).\nA semi-integrated terminal is one that is connected to a POS system, typically through a network or cable.\n\nExample: 7909bab1-5d93-4262-977d-e3f6277f58ef\n","example":"7909bab1-5d93-4262-977d-e3f6277f58ef"}},"additionalProperties":false}},"components/schemas/ZeroCostProcessingOption":{"id":"components/schemas/ZeroCostProcessingOption","kind":"json-schema","title":"ZeroCostProcessingOption","data":{"enum":["None","CashDiscount","DualPricing","Surcharge"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the zero cost processing option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zero cost processing is a pricing strategy that the merchant passes the cost of credit card processing fees on to the customer."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result is that the merchant pays little to no fees."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CashDiscount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customers paying with cash receive a discount off the posted price."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DualPricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two prices are displayed side by side. This is a cash price and a card price. The customer chooses which to pay."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"None"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant absorbs the processing fees themselves."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fee is added to the transaction when a customer pays by credit card. The surcharge amount covers the processing cost."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: DualPricing"},"children":[]}]}]}],"example":"DualPricing"}},"components/schemas/Currency":{"id":"components/schemas/Currency","kind":"json-schema","title":"Currency","data":{"enum":["USD"],"type":"string","description":"Indicates the available currency (in ISO 4217 currency code).\n\nExample: USD\n","example":"USD"}},"components/schemas/PaymentProcessorType":{"id":"components/schemas/PaymentProcessorType","kind":"json-schema","title":"PaymentProcessorType","data":{"enum":["Tsys","Ach","SandboxCard","SandboxAch"],"type":"string","description":"Indicates the processor type.\n\nExample: SandboxCard\n","example":"SandboxCard"}},"components/schemas/PaymentConfigurationResponseDtoSettlementBatchTimeSlotDto":{"id":"components/schemas/PaymentConfigurationResponseDtoSettlementBatchTimeSlotDto","kind":"json-schema","title":"PaymentConfigurationResponseDtoSettlementBatchTimeSlotDto","data":{"type":"object","properties":{"hours":{"type":"integer","format":"int32","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the hour (in 24 hour format) of the time slot."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"9"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"13"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"example":9},"minutes":{"type":"integer","format":"int32","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the minutes of the time slot."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"30"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"45"},"children":[]}]}]}]},"timezoneName":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the timezone name (in IANA Time Zone Database format)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"America/New_York"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Europe/London"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Asia/Tokyo"},"children":[]}]}]}],"example":"America/New_York"}},"additionalProperties":false}},"components/schemas/PaymentConfigurationResponseDtoPaymentProcessorDto":{"id":"components/schemas/PaymentConfigurationResponseDtoPaymentProcessorDto","kind":"json-schema","title":"PaymentConfigurationResponseDtoPaymentProcessorDto","data":{"type":"object","properties":{"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"},"processorName":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the payment processor name.\n\nExample: TSYS\n","example":"TSYS"},"isDefault":{"type":"boolean","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates this payment method is the default payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is the default payment method."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is not the default payment method."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"type":{"$ref":"#/components/schemas/PaymentProcessorType"},"settlementBatchTimeSlots":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/PaymentConfigurationResponseDtoSettlementBatchTimeSlotDto"},"description":"Indicates an object for settlement batch time slots.","nullable":true}},"additionalProperties":false}},"components/schemas/AvsMerchantProfile":{"id":"components/schemas/AvsMerchantProfile","kind":"json-schema","title":"AvsMerchantProfile","data":{"enum":["Strict","Moderate","Tolerant"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the AVS (address verification service) tolerance levels."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Moderate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either the street address or ZIP code matches but not necessarily both."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strict"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both the street address and ZIP code must match exactly."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tolerant"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No AVS verification is performed. The transaction is accepted regardless if the address matches."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Moderate"},"children":[]}]}]}],"example":"Moderate"}},"components/schemas/PaymentConfigurationResponseDtoAddressVerificationServiceOptionsDto":{"id":"components/schemas/PaymentConfigurationResponseDtoAddressVerificationServiceOptionsDto","kind":"json-schema","title":"PaymentConfigurationResponseDtoAddressVerificationServiceOptionsDto","data":{"type":"object","properties":{"isEnabled":{"type":"boolean","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the AVS (address verification service) is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", AVS is enabled."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", AVS is not enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"profile":{"$ref":"#/components/schemas/AvsMerchantProfile"}},"additionalProperties":false}},"components/schemas/PaymentConfigurationResponseDto":{"id":"components/schemas/PaymentConfigurationResponseDto","kind":"json-schema","title":"PaymentConfigurationResponseDto","data":{"type":"object","properties":{"zeroCostProcessingOption":{"$ref":"#/components/schemas/ZeroCostProcessingOption"},"defaultTipsOptions":{"type":"array","x-method":"response","items":{"type":"number","format":"double"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the default tip percentage suggestion options."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an array of percentage values that display at the time of purchase."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"They offer preselected tip percentage suggestions as a convenience for the purchasers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: [ 15, 18, 20 ] (as 15%, 18%, and 20%)"},"children":[]}]}]}],"example":[15,18,20],"nullable":true},"defaultSurchargeRate":{"type":"number","format":"double","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the default surcharge rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1.5 (as 1.5%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 (as 5%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"22 (as 22%)"},"children":[]}]}]}],"example":1.5},"defaultCashDiscountRate":{"type":"number","format":"double","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the cash discount rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1.5 (as 1.5%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 (as 5%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20 (as 20%)"},"children":[]}]}]}],"example":1.5},"defaultDualPricingRate":{"type":"number","format":"double","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the default dual pricing rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1.8 (as 1.8%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5 (as 5%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"20 (as 20%)"},"children":[]}]}]}],"example":1.8},"availableCurrencies":{"type":"array","nullable":true,"x-method":"response","items":{"$ref":"#/components/schemas/Currency"},"description":"Indicates the available currencies (in ISO 4217 currency code).\n\nExample: USD\n","example":["USD"]},"availableCardTypes":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/CardType"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the available card types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: [ \"Visa\", \"MasterCard\", \"AmericanExpress\" ]"},"children":[]}]}]}],"example":["Visa","MasterCard","AmericanExpress"],"nullable":true},"availableTransactionTypes":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/TransactionType"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the available transaction types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: [ \"Authorization\", \"Sale\", \"Refund\" ]"},"children":[]}]}]}],"example":["Authorization","Sale","Refund"],"nullable":true},"isTipsEnabled":{"type":"boolean","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates tips are enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", tips are enabled."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", tips are not enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"availablePaymentProcessors":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/PaymentConfigurationResponseDtoPaymentProcessorDto"},"description":"Indicates the available payment processors.\n","nullable":true},"addressVerificationServiceOptions":{"$ref":"#/components/schemas/PaymentConfigurationResponseDtoAddressVerificationServiceOptionsDto"},"isCustomerCardSavingByTerminalEnabled":{"type":"boolean","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the terminal can save customer card after a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the terminal can save customer card after a transaction."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the terminal cannot save customer card after a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"companyName":{"type":"string","x-method":"response","description":"Indicates the name of the customer's company or organization.\n\nThis is a free-formed name that is convenient for the merchant to recognize.\n\nExample: Peppared Street Cafe\n","example":"Peppared Street Cafe","nullable":true},"mccCode":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the MCC (merchant category code).\n\nExample: 5411\n","example":"5411"},"mccCodeDescription":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the MCC (merchant category code) description.\n\nExample: Grocery Stores, Supermarkets\n","example":"Grocery Stores, Supermarkets"},"currency":{"$ref":"#/components/schemas/currencyCode"},"maxTransactionAmount":{"type":"number","format":"double","x-method":"response","nullable":true,"description":"Indicates the maximum transaction amount limit.\n\nExample: 10000\n","example":10000},"ttpIosTerminalProfileId":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the TTP (tap-to-pay terminal) profile identifier for iOS devices.\n\nExample: ttp-ios-profile-123\n","example":"ttp-ios-profile-123"}},"additionalProperties":false,"description":"Indicates an object describing the payment configuration settings for the merchant."}},"components/schemas/ContactInfoResponseDtoMerchantContactInfoDto":{"id":"components/schemas/ContactInfoResponseDtoMerchantContactInfoDto","kind":"json-schema","title":"ContactInfoResponseDtoMerchantContactInfoDto","data":{"type":"object","properties":{"addressLine1":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the first line of the address.\n\nExample: 123 Main Street\n","example":"123 Main Street"},"addressLine2":{"type":"string","nullable":true,"x-method":"response","description":"Indicates an optional second line of the address.\n\nExample: Suite 400\n","example":"Suite 400"},"city":{"type":"string","x-method":"response","nullable":true,"description":"Indicates the name of the city.\n\nExample: Chicago\n","example":"Chicago"},"postalCode":{"type":"string","nullable":true,"minLength":2,"maxLength":15,"x-method":"response","description":"Indicates the postal or ZIP code.\n\nExample: 10001\n","example":"10001"},"stateCode":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the state identifier (in two-letter USPS [United States Postal Service] postal code)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For regions outside the US, use the ISO 3166-2 format."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TX"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WA"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IL"},"children":[]}]}]}],"example":"NY"},"countryCode":{"type":"string","minLength":2,"maxLength":2,"nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the country identifier (in two letter ISO 3166-1 format)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CA"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GB"},"children":[]}]}]}],"example":"US"},"contactInfoId":{"type":"string","format":"uuid","x-method":"response","description":"Indicates the contact information record identifier.\n\nExample: 91e0278b-02e8-4963-8710-fe3dfca39d51\n","example":"91e0278b-02e8-4963-8710-fe3dfca39d51"},"addressName":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the name or label of the address.\n\nExample: Main office\n","example":"Main office"},"email":{"type":"string","x-method":"response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: peppared@example.com"},"children":[]}]}]}],"example":"peppared@example.com"},"mobilePhoneNumber":{"type":"string","x-method":"response","nullable":true,"format":"E.164","maxLength":20,"pattern":"^(null|\\+\\d{1,20})$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the customer's mobile phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: +14155552309"},"children":[]}]}]}],"example":"+14155552309"},"isMainAddress":{"type":"boolean","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates this is the main address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is the main address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is not the main address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"isDefaultAddress":{"type":"boolean","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates this is the default shipping address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is the default shipping address."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this is not the default shipping address."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true}},"additionalProperties":false}},"components/schemas/ContactInfoResponseDto":{"id":"components/schemas/ContactInfoResponseDto","kind":"json-schema","title":"ContactInfoResponseDto","data":{"type":"object","properties":{"contactInfos":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/ContactInfoResponseDtoMerchantContactInfoDto"},"description":"Indicates an object for the merchant contact information.","nullable":true}},"additionalProperties":false}},"components/schemas/Level2SettingsDto":{"id":"components/schemas/Level2SettingsDto","kind":"json-schema","title":"Level2SettingsDto","data":{"type":"object","properties":{"taxRate":{"type":"number","format":"double","minimum":0,"maximum":22,"x-method":"request/response","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the default level 2 autoFill sales tax rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5.0 (for 5.0%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8.5 (for 8.5%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.25 (for 10.25%)"},"children":[]}]}]}],"example":8.5}},"additionalProperties":false}},"components/schemas/ProductDto":{"id":"components/schemas/ProductDto","kind":"json-schema","title":"ProductDto","data":{"type":"object","properties":{"productName":{"type":"string","x-method":"request","description":"Specifies the name of the product.\n\nExample: Widget\n","nullable":true,"example":"Widget"},"code":{"type":"string","x-method":"request","description":"Specifies the merchant assigned unique product identification code.\n\nThe code may only contain letters, digits, spaces, and slashes.\n\nExample: SKU/12345\n","nullable":true,"example":"SKU/12345"},"unitPrice":{"type":"number","format":"double","x-method":"request","nullable":true,"description":"Specifies the  unit price for the product.\n\nExample: 19.99\n","example":19.99},"measurementUnit":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the unit of measurement for the product.\n\nExample: EA\n","example":"EA"},"quantity":{"type":"number","description":"Specifies the quantity of the product.\n\nExample: 1\n","format":"double","x-method":"request","nullable":true,"example":1},"discountPercentage":{"type":"number","format":"double","x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the product discount percentage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 10.5 (for 10.5%)"},"children":[]}]}]}],"example":10},"description":{"type":"string","x-method":"request","description":"Specifies the product description.\n\nExample: Sample cologne for conference.\n","example":"Sample cologne for conference","nullable":true}},"additionalProperties":false}},"components/schemas/Level3SettingsDto":{"id":"components/schemas/Level3SettingsDto","kind":"json-schema","title":"Level3SettingsDto","data":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/ProductDto"},"shippingChargeRate":{"type":"number","format":"double","x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the percentage for shipping or freight charges applied to a product or transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.5 (for 2.5%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8.5 (for 8.5%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.25 (for 10.25%)"},"children":[]}]}]}],"example":2.5},"dutyChargeRate":{"type":"number","format":"double","x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.5 (for 2.5%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"8.5 (for 8.5%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10.25 (for 10.25%)"},"children":[]}]}]}],"example":2.5}},"additionalProperties":false}},"components/schemas/TransactionAutofillResponseDto":{"id":"components/schemas/TransactionAutofillResponseDto","kind":"json-schema","title":"TransactionAutofillResponseDto","data":{"type":"object","properties":{"level2Settings":{"$ref":"#/components/schemas/Level2SettingsDto"},"level3Settings":{"$ref":"#/components/schemas/Level3SettingsDto"}},"additionalProperties":false,"description":"Transaction autofill settings configured for the merchant."}},"components/schemas/UpdateTransactionAutofillRequestDto":{"id":"components/schemas/UpdateTransactionAutofillRequestDto","kind":"json-schema","title":"UpdateTransactionAutofillRequestDto","data":{"required":["level2Settings","level3Settings"],"type":"object","properties":{"level2Settings":{"$ref":"#/components/schemas/Level2SettingsDto"},"level3Settings":{"$ref":"#/components/schemas/Level3SettingsDto"}},"additionalProperties":false}},"components/schemas/batchId":{"id":"components/schemas/batchId","kind":"json-schema","title":"batchId","data":{"type":"string","format":"uuid","x-method":"response","nullable":true,"description":"Indicates the batch settlement identifier.\n\nExample: 42df0a13-4bf4-48f8-929c-08a379c0a0d6\n","example":"42df0a13-4bf4-48f8-929c-08a379c0a0d6"}},"components/schemas/SettlementBatchStatus":{"id":"components/schemas/SettlementBatchStatus","kind":"json-schema","title":"SettlementBatchStatus","data":{"name":"status","in":"query","required":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the batch settlement type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An open batch is still active and accepting transactions."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A settled batch has completed processing with the acquirer or bank."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Open"},"children":[]}]}]}],"schema":{"type":"string","example":"Open"}}},"components/schemas/ListBatchesResponseDto":{"id":"components/schemas/ListBatchesResponseDto","kind":"json-schema","title":"ListBatchesResponseDto","data":{"type":"object","properties":{"batchId":{"$ref":"#/components/schemas/batchId"},"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"},"paymentProcessorName":{"type":"string","x-method":"response","description":"Indicates the name of the payment processor.\n\nExample: TSYS\n","nullable":true,"example":"TSYS"},"externalBatchId":{"type":"string","x-method":"response","description":"Indicates the external batch identifier from the payment processor.\n\nExample: BATCH-EXT-001\n","nullable":true,"example":"BATCH-EXT-001"},"batchDateTime":{"type":"string","description":"Indicates the date and time when the batch was created or processed.\n\nExample: 2026-05-05T18:00:56.264Z\n","format":"date-time","x-method":"response","nullable":true,"example":"2026-05-05T18:00:56.264Z"},"transactionCount":{"type":"integer","format":"int32","x-method":"response","description":"Indicates the total number of transactions in the batch.\n\nExample: 36\n","example":36},"netAmount":{"type":"number","format":"double","x-method":"response","description":"Indicates the net amount after all transactions (sales minus refunds).\n\nExample: 9500\n","example":9500},"salesAmount":{"type":"number","format":"double","x-method":"response","description":"Indicates the total amount of sales in the batch.\n\nExample: 9562.18\n","example":9562.18},"refundsAmount":{"type":"number","format":"double","x-method":"response","description":"Indicates the total amount of refunds in the batch.\n\nExample: 486.23\n","example":486.23},"status":{"$ref":"#/components/schemas/SettlementBatchStatus"}},"additionalProperties":false,"description":"Settlement batch details."}},"components/schemas/PageOfListBatchesResponseDto":{"id":"components/schemas/PageOfListBatchesResponseDto","kind":"json-schema","title":"PageOfListBatchesResponseDto","data":{"type":"object","properties":{"items":{"type":"array","x-method":"response","description":"Indicates an object returning found batch settlements.\n","items":{"$ref":"#/components/schemas/ListBatchesResponseDto"},"nullable":true},"pageInfo":{"$ref":"#/components/schemas/pageInfo"}},"additionalProperties":false}},"components/schemas/SettleTransactionsRequestDto":{"id":"components/schemas/SettleTransactionsRequestDto","kind":"json-schema","title":"SettleTransactionsRequestDto","data":{"required":["paymentProcessorId"],"type":"object","properties":{"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"}},"additionalProperties":false,"description":"Request to settle (close) a batch of transactions for a given payment processor.\n"}},"components/schemas/ResponseCode":{"id":"components/schemas/ResponseCode","kind":"json-schema","title":"ResponseCode","data":{"enum":["Approve","Decline","Error"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the status of the batch payment submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approve"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The settlement was accepted or processed successfully."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decline"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The settlement was rejected by the processor or acquirer such as by failed validation, insufficient funds, or closed account, risk or fraud rule."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request could not be completed due to a system or processing issue such as by a timeout, malformed data, downstream failure. This is distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Decline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is an explicit business decision rejection."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Approve"},"children":[]}]}]}],"example":"Approve"}},"components/schemas/SettleTransactionsResponseDto":{"id":"components/schemas/SettleTransactionsResponseDto","kind":"json-schema","title":"SettleTransactionsResponseDto","data":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ResponseCode"},"message":{"type":"string","x-method":"response","description":"Indicates a descriptive message about the settlement result.\n\nExample: Batch settled successfully\n","nullable":true,"example":"Batch settled successfully"},"processorResponseCode":{"type":"string","x-method":"response","description":"Indicates a response code from the payment processor.\n\nExample: 00\n","nullable":true,"example":"00"}},"additionalProperties":false,"description":"Response after settling (closing) a batch of transactions."}},"components/schemas/TerminalManufacturer":{"id":"components/schemas/TerminalManufacturer","kind":"json-schema","title":"TerminalManufacturer","data":{"enum":["Sunmi","Verifone"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the terminal manufacturer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manufacturer"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sunmi"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifone"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Verifone"},"children":[]}]}]}],"example":"Verifone"}},"components/schemas/TerminalModel":{"id":"components/schemas/TerminalModel","kind":"json-schema","title":"TerminalModel","data":{"enum":["SunmiP2","SunmiP2LiteSe","VerifoneVictaMobile","VerifoneVictaPortable","SunmiP3H"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the model of the terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Model"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SunmiP2"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SunmiP2LiteSe"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VerifoneVictaMobile"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VerifoneVictaPortable"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SunmiP3H"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: SunmiP2LiteSe"},"children":[]}]}]}],"example":"SunmiP2LiteSe"}},"components/schemas/TerminalMode":{"id":"components/schemas/TerminalMode","kind":"json-schema","title":"TerminalMode","data":{"enum":["Standalone","SemiIntegrated"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the operating mode of the terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standalone"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal operates independently of any POS system. The amount is entered directly on the terminal itself (no electronic connection to a cash register/POS software), and it runs the transaction on its own."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SemiIntegrated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal is connected to a POS system, typically through a network or cable. The POS sends the transaction amount to the terminal electronically, rather than requiring manual entry. However, the POS never touches card or payment data directly. The terminal handles all sensitive payment processing itself. This architecture is commonly used to reduce PCI compliance scope on the POS side."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Standalone"},"children":[]}]}]}],"example":"Standalone"}},"components/schemas/TerminalPosStatus":{"id":"components/schemas/TerminalPosStatus","kind":"json-schema","title":"TerminalPosStatus","data":{"enum":["Active","Busy","Offline"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the terminal status to process a new transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal is powered on and available."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is ready to process a new transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Busy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal is currently processing a transaction."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is not available to accept another one until that transaction completes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offline"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal is disconnected or unreachable."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It cannot process transactions until connectivity is restored."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Active"},"children":[]}]}]}],"example":"Active"}},"components/schemas/TerminalConnectionStatus":{"id":"components/schemas/TerminalConnectionStatus","kind":"json-schema","title":"TerminalConnectionStatus","data":{"enum":["Online","Offline"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the line status of the terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Online"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal is currently connected and reachable."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It has active network or internet connectivity. It is able to process transactions and communicate with the backend in real time."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offline"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal is disconnected or unreachable."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It may be powered off, have lost its network connection, or otherwise be unable to communicate. As a result, it cannot process transactions, or can only do so in a stored or deferred mode depending on the platform."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Online"},"children":[]}]}]}],"example":"Online"}},"components/schemas/ListTerminalsResponseDto":{"id":"components/schemas/ListTerminalsResponseDto","kind":"json-schema","title":"ListTerminalsResponseDto","data":{"type":"object","properties":{"terminalId":{"type":"string","format":"uuid","x-method":"response","description":"Indicates the identifier of terminal handling the POS transaction.\n\nExample: d0fc1606-47ea-464b-a31a-3971c9822d10\n","example":"d0fc1606-47ea-464b-a31a-3971c9822d10"},"merchantId":{"$ref":"#/components/schemas/merchantId"},"merchantCompanyName":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the company name of the merchant associated with the terminal.\n\nExample: Peppared Street Cafe\n","example":"Peppared Street Cafe"},"serialNumber":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the terminal serial number.\n\nExample: SN0123456789\n","example":"SN0123456789"},"terminalManufacturer":{"$ref":"#/components/schemas/TerminalManufacturer"},"terminalModel":{"$ref":"#/components/schemas/TerminalModel"},"terminalMode":{"$ref":"#/components/schemas/TerminalMode"},"terminalStatus":{"$ref":"#/components/schemas/TerminalPosStatus"},"connectionStatus":{"$ref":"#/components/schemas/TerminalConnectionStatus"},"lastSeenOn":{"type":"string","format":"date-time","x-method":"response","nullable":true,"description":"Indicates the timestamp (in an ISO 8601 date-time UTC format) that the terminal was last seen online.\n\nExample: 2026-05-05T13:25:22.344Z\n","example":"2026-05-05T13:25:22.344Z"}},"additionalProperties":false,"description":"Response DTO for a terminal in the list."}},"components/schemas/PageOfListTerminalsResponseDto":{"id":"components/schemas/PageOfListTerminalsResponseDto","kind":"json-schema","title":"PageOfListTerminalsResponseDto","data":{"type":"object","properties":{"items":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/ListTerminalsResponseDto"},"nullable":true},"pageInfo":{"$ref":"#/components/schemas/pageInfo"}},"additionalProperties":false}},"components/schemas/TerminalDebitPinKey":{"id":"components/schemas/TerminalDebitPinKey","kind":"json-schema","title":"TerminalDebitPinKey","data":{"enum":["Injected","Missing"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the debit PIN key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A debit PIN key is a cryptographic key used specifically to encrypt the cardholder's PIN during a debit transaction on a payment terminal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a customer enters their PIN on a PIN pad or terminal, that PIN must be encrypted immediately within the terminal's secure hardware (never transmitted in plaintext) to comply with PCI PIN security standards."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The debit PIN key is what performs that encryption."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is typically injected into the terminal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is often as part of a DUKPT (derived unique key per transaction) scheme, or a fixed key-encryption-key setup."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal can encrypt the PIN block before it's sent onward for authorization."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the debitPinKey is missing, the terminal cannot securely accept PIN-debit transactions until that key is loaded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Injected"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal has had its encryption or security keys loaded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is properly provisioned to process secure payment data."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal does not have its encryption or security keys loaded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It cannot securely process payment data until keys are injected."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Injected"},"children":[]}]}]}],"example":"Injected"}},"components/schemas/TerminalConnectionType":{"id":"components/schemas/TerminalConnectionType","kind":"json-schema","title":"TerminalConnectionType","data":{"enum":["WiFi","Mobile","Ethernet"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the connection type for the terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ethernet"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal connects through a wired network cable."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This typically offers the most stable and reliable connection."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mobile"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal connects using a cellular data connection."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is useful when Wi-Fi or Ethernet isn't available, such as in the field."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WiFi"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The terminal connects through a wireless local network."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This offers mobility within range of the wireless access point without a physical cable."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Ethernet"},"children":[]}]}]}],"example":"Ethernet"}},"components/schemas/TerminalPrinterStatus":{"id":"components/schemas/TerminalPrinterStatus","kind":"json-schema","title":"TerminalPrinterStatus","data":{"enum":["Normal","NotNormal","NotSupported"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the printer status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Normal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The device is functioning correctly."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NotNormal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The device has an issue or fault."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NotSupported"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The device does not support this feature."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Normal"},"children":[]}]}]}],"example":"Normal"}},"components/schemas/GetTerminalStatusResponseDto":{"id":"components/schemas/GetTerminalStatusResponseDto","kind":"json-schema","title":"GetTerminalStatusResponseDto","data":{"type":"object","properties":{"terminalId":{"type":"string","format":"uuid","x-method":"response","description":"Indicates the terminal identifier that handles the transaction.\n\nThis is a mirror of the path parameter.\n\nThe terminal must be in semi-integrated mode and available (online and ready).\nA semi-integrated terminal is one that is connected to a POS system, typically through a network or cable.\n\nExample: 0dfac966-9dbd-4608-a65f-d6a4c961dd35\n","example":"0dfac966-9dbd-4608-a65f-d6a4c961dd35"},"merchantId":{"$ref":"#/components/schemas/merchantId"},"terminalStatus":{"$ref":"#/components/schemas/TerminalPosStatus"},"lastSeenOn":{"type":"string","format":"date-time","x-method":"response","nullable":true,"description":"Indicates the timestamp (in an ISO 8601 date-time UTC format) that the terminal was last seen online.\n\nExample: 2026-05-05T13:25:32.223Z\n","example":"2026-05-05T13:25:32.223Z"},"debitPinKey":{"$ref":"#/components/schemas/TerminalDebitPinKey"},"terminalAppVersion":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the terminal version.\n\nExample: 1.4.2\n","example":"1.4.2"},"connectionStatus":{"$ref":"#/components/schemas/TerminalConnectionStatus"},"connectionType":{"$ref":"#/components/schemas/TerminalConnectionType"},"wifiConnectionStrength":{"type":"integer","format":"int32","x-method":"response","minimum":0,"maximum":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the WiFi connection strength as a percent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 45 (as 45%)"},"children":[]}]}]}],"example":45},"mobileConnectionStrength":{"type":"integer","format":"int32","x-method":"response","minimum":0,"maximum":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the mobile connection strength as a percent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 87 (as 87%)"},"children":[]}]}]}],"example":87},"batteryLevel":{"type":"integer","format":"int32","x-method":"response","minimum":0,"maximum":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the battery level as a percent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 52 (as 52%)"},"children":[]}]}]}],"example":52},"printerStatus":{"$ref":"#/components/schemas/TerminalPrinterStatus"}},"additionalProperties":false}},"components/schemas/AmountBreakdownDto":{"id":"components/schemas/AmountBreakdownDto","kind":"json-schema","title":"AmountBreakdownDto","data":{"type":"object","properties":{"baseAmount":{"$ref":"#/components/schemas/baseAmount"},"tipAmount":{"type":"number","format":"double","x-method":"response","multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the absolute amount (in USD) of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 14.50 (for $14.50)"},"children":[]}]}]}],"example":14.5},"tipRate":{"type":"number","format":"double","x-method":"response","multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates a percentage of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 18.50 (for 18.50%)"},"children":[]}]}]}],"example":18.5},"discountAmount":{"type":"number","format":"double","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the absolute amount (in USD) of discount to be applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 25 (for $25)"},"children":[]}]}]}],"example":25},"discountRate":{"type":"number","format":"double","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates a percentage of a discount to be applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 5.5 (for 5.5%)"},"children":[]}]}]}],"example":5.5},"surchargeAmount":{"type":"number","format":"double","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the surcharge amount (in USD) applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 22 (for $22)"},"children":[]}]}]}],"example":22},"surchargeRate":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the percent of transaction amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is added to the base amount after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PercentageOffRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"surchargeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 2.5 (for 2.5%)"},"children":[]}]}]}],"example":2.5}},"additionalProperties":false,"description":"Indicates an object detailing the amount breakdown details."}},"components/schemas/TransactionCardDetailsDtoShort":{"id":"components/schemas/TransactionCardDetailsDtoShort","kind":"json-schema","title":"TransactionCardDetailsDtoShort","data":{"type":"object","description":"Indicates the card details exposed on transaction responses.\n\nThese may be masked for sensitive fields or fully displayed for non-sensitive fields.\n","properties":{"paymentMethodId":{"$ref":"#/components/schemas/paymentMethodIdResponse"},"maskedCardNumber":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the masked card number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This displays only the last four numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: ************1111"},"children":[]}]}]}],"example":"************1111"},"cardBrand":{"$ref":"#/components/schemas/CardType"},"cardType":{"$ref":"#/components/schemas/CreditDebitType"},"cardProcessedAsType":{"$ref":"#/components/schemas/CreditDebitType"},"cardDataSource":{"$ref":"#/components/schemas/CardDataSourceDto"},"cardholderVerificationMethod":{"$ref":"#/components/schemas/CardholderAuthenticationMethodDto"}},"additionalProperties":false}},"components/schemas/AchDetailsDtoShort":{"id":"components/schemas/AchDetailsDtoShort","kind":"json-schema","title":"AchDetailsDtoShort","data":{"type":"object","description":"Indicates ACH account details exposed on transaction responses.\n\nThese may be masked for sensitive fields or fully displayed for non-sensitive fields.\n","properties":{"paymentMethodId":{"$ref":"#/components/schemas/paymentMethodIdResponse"},"maskedAccountNumber":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the masked ACH account number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This displays only the last four numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: **************89"},"children":[]}]}]}],"example":"**************89"},"accountRoutingNumber":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the masked ACH routing number.\n\nExample: 123123123\n","example":"123123123"},"accountHolderType":{"$ref":"#/components/schemas/AccountHolderType"},"accountType":{"$ref":"#/components/schemas/AccountType"},"secCode":{"$ref":"#/components/schemas/AchSECCode"},"isSameDayProcessing":{"type":"boolean","nullable":true,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates same-day ACH processing for faster settlement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the transaction uses the same-day ACH processing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the transaction does not use the same-day ACH processing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null or omitted, the default standard ACH processing is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true}},"additionalProperties":false}},"components/schemas/source":{"id":"components/schemas/source","kind":"json-schema","title":"source","data":{"type":"object","description":"Indicates an object describing the origination of the transaction.\n","properties":{"sourceType":{"enum":["Portal","ApiKey","Terminal","Invoice","QuickPayment","WebComponent","Subscription","MobileApp","TapToPay"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the source of the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ApiKey"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An external application created the transaction using an API key."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoice"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A billed invoice created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MobileApp"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A mobile application created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Portal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A staff member created the transaction through the web portal."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QuickPayment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A one-time payment link created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A recurring subscription created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TapToPay"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A mobile device using tap to pay created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminal"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A physical payment terminal created the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WebComponent"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An embedded web component created the transaction."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: QuickPayment"},"children":[]}]}]}],"example":"QuickPayment"},"sourceId":{"type":"string","format":"uuid","nullable":true,"description":"Indicates the Identifier of the originating entity.\n\nExample: 3fa85f64-5717-4562-b3fc-2c963f66afa6\n","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"sourceName":{"type":"string","nullable":true,"description":"Indicates a human-readable name of the originator.\n\nExample: API Key for ecommerce app\n","example":"API Key for ecommerce app"}},"additionalProperties":false}},"components/schemas/GetTransactionResponseDtoShort":{"id":"components/schemas/GetTransactionResponseDtoShort","kind":"json-schema","title":"GetTransactionResponseDtoShort","data":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid","x-method":"response","nullable":true,"description":"Indicates the attached transaction identifier.\n\nThis value is available after processing.\n\nExample: f01339ec-8184-48c7-b58d-0780d6499ef4\n","example":"f01339ec-8184-48c7-b58d-0780d6499ef4"},"transactionDateTime":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 date-time format) of the transaction.\n\nExample: 2026-05-05T14:30:42.938Z\n","example":"2026-05-05T14:30:42.938Z"},"transactionStatus":{"$ref":"#/components/schemas/AggregatedTransactionStatus"},"transactionType":{"$ref":"#/components/schemas/TransactionType"},"cardTokenType":{"$ref":"#/components/schemas/TokenType"},"paymentMethodType":{"$ref":"#/components/schemas/PaymentMethodType"},"referenceId":{"type":"string","x-method":"response","nullable":true,"minLength":0,"maxLength":36,"description":"Indicates a reference identifier provided by the merchant.\n\nThis is included in the duplicate-check key.\nIt allows the same card and amount combination to be charged multiple times when the reference identifiers are different.\n\nExample: REF-EXT-12345\n","example":"REF-EXT-12345"},"processedAmount":{"$ref":"#/components/schemas/processedAmount"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"pricingType":{"$ref":"#/components/schemas/PricingType"},"merchantId":{"$ref":"#/components/schemas/merchantId"},"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"},"customerId":{"$ref":"#/components/schemas/customerId"},"batchId":{"$ref":"#/components/schemas/batchId"},"amountBreakdown":{"$ref":"#/components/schemas/AmountBreakdownDto"},"cardDetails":{"$ref":"#/components/schemas/TransactionCardDetailsDtoShort"},"achDetails":{"$ref":"#/components/schemas/AchDetailsDtoShort"},"processorDetails":{"$ref":"#/components/schemas/processorDetails"},"source":{"$ref":"#/components/schemas/source"}},"additionalProperties":false}},"components/schemas/PageOfGetTransactionResponseDto":{"id":"components/schemas/PageOfGetTransactionResponseDto","kind":"json-schema","title":"PageOfGetTransactionResponseDto","data":{"type":"object","properties":{"items":{"type":"array","x-method":"response","items":{"$ref":"#/components/schemas/GetTransactionResponseDtoShort"},"nullable":true},"pageInfo":{"$ref":"#/components/schemas/pageInfo"}},"additionalProperties":false}},"components/schemas/TransactionProductIsvDto":{"id":"components/schemas/TransactionProductIsvDto","kind":"json-schema","title":"TransactionProductIsvDto","data":{"type":"object","properties":{"productName":{"type":"string","nullable":true,"minLength":1,"maxLength":15,"x-method":"request","description":"Specifies the name of the product.\n\nThe code may only contain letters, digits, spaces, slashes, hyphen, and commas.\n\nExample: Express Duo\n","example":"Express Duo"},"productDescription":{"type":"string","minLength":1,"maxLength":200,"nullable":true,"x-method":"request","description":"Specifies the description of the product.\n\nExample: Standard office supplies\n","example":"Standard office supplies"},"productCode":{"type":"string","nullable":true,"minLength":1,"maxLength":20,"x-method":"request","description":"Specifies the merchant's assigned unique product identification code.\n\nThe code may only contain letters, digits, spaces, slashes, hyphen, and commas.\n\nExample: HLA/6372\n","example":"HLA/6372"},"unitPrice":{"type":"number","format":"double","x-method":"request","nullable":true,"description":"Specifies the product price (in USD) for each unit. \n\nExample: 3.99\n","example":3.99},"measurementUnit":{"type":"string","minLength":1,"maxLength":20,"nullable":true,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the unit of measurement for the product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code may only contain letters, digits, and spaces."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No special characters are allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EA"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LB"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DAY"},"children":[]}]}]}],"example":"EA"},"quantity":{"type":"number","format":"double","x-method":"request","nullable":true,"description":"Specifies the quantity of a product.\n\nExample: 12\n","example":12},"taxAmount":{"type":"number","format":"double","x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the tax amount established on a product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 3.75 (for 3.75%)"},"children":[]}]}]}],"example":3.75},"discountRate":{"type":"number","format":"double","minimum":0.01,"maximum":199,"x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the discount percentage applied to a product."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"10 (for 10%)"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2.5 (for 2.5%)"},"children":[]}]}]}],"example":10}},"additionalProperties":false}},"components/schemas/TransactionEnhancedDataDto":{"id":"components/schemas/TransactionEnhancedDataDto","kind":"json-schema","title":"TransactionEnhancedDataDto","data":{"type":"object","properties":{"salesTaxRate":{"type":"number","format":"double","minimum":0.01,"maximum":100,"x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sales tax rate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 8.5 (for 8.5%)"},"children":[]}]}]}],"example":8.5},"invoiceNumber":{"type":"string","nullable":true,"maxLength":16,"x-method":"request","description":"Specifies the VAT (value added tax) invoice number associated with the transaction.\n\nThe code may only contain letters, digits, and spaces.\n\nExample: INV-001234\n","example":"INV-001234"},"purchaseOrder":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the value used by the customer to identify an order.\n\nIssued by the buyer to the seller.\n\nThe code may only contain letters, digits, and spaces.\n\nExample: PO-2026-0001\n","example":"PO-2026-0001"},"shippingCharges":{"type":"number","format":"double","multipleOf":0.01,"x-method":"request","nullable":true,"description":"Specifies the amount (in USD) for shipping or freight charges applied to a product or transaction.\n\nExample:  129.99\n","example":129.99},"dutyCharges":{"type":"number","format":"double","maxLength":12,"x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the total charges for any import or export duties included in the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 2.5 (for 2.5%)"},"children":[]}]}]}],"example":2.5},"products":{"type":"array","x-method":"request","items":{"$ref":"#/components/schemas/TransactionProductIsvDto"},"description":"Multiple products may be sent in a single request.","nullable":true}},"additionalProperties":false,"description":"Specifies a combined Level 2 and Level 3 enhanced data for card transactions.\nUsed for commercial card processing with additional transaction details.\n"}},"components/schemas/ContactInfoDto":{"id":"components/schemas/ContactInfoDto","kind":"json-schema","title":"ContactInfoDto","data":{"type":"object","properties":{"firstName":{"type":"string","x-method":"request","description":"Specifies the customer's first name.\n\nExample: Alexandro\n","example":"Alexandro","nullable":true},"lastName":{"type":"string","x-method":"request","description":"Specifies the customer's last name.\n\nExample: Peppared\n","example":"Peppared","nullable":true},"companyName":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the name of the customer's company or organization.\n\nExample: Peppared Street Cafe\n","example":"Peppared Street Cafe"},"email":{"type":"string","x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the customer's email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: peppared@example.com"},"children":[]}]}]}],"example":"peppared@example.com"},"mobilePhoneNumber":{"type":"string","x-method":"request","nullable":true,"format":"E.164","maxLength":20,"pattern":"^(null|\\+\\d{1,20})$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the customer's mobile phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: +14155552309"},"children":[]}]}]}],"example":"+14155552309"},"hasSmsConsent":{"type":"boolean","default":false,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the customer has consented to receiving the SMS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer has consented to receiving the SMS."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer has not consented to receiving the SMS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true}},"additionalProperties":false,"description":"Contact information."}},"components/schemas/PaymentMethodCardDetailsDto":{"id":"components/schemas/PaymentMethodCardDetailsDto","kind":"json-schema","title":"PaymentMethodCardDetailsDto","data":{"type":"object","properties":{"cardNumber":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the card number (either credit or debit) used for the transaction.\n\nExample: 4111111111111111\n","example":"4111111111111111"},"securityCode":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the securityCode (sometimes also called similarly to CCV) for the card.\n\nThis is a three or four digit security code on the credit card.\n\nExample: 483\n","example":"483"},"expirationMonth":{"$ref":"#/components/schemas/expirationMonthRequest"},"expirationYear":{"$ref":"#/components/schemas/expirationYearRequest"}},"additionalProperties":false}},"components/schemas/CardDataDto":{"id":"components/schemas/CardDataDto","kind":"json-schema","title":"CardDataDto","data":{"type":"object","properties":{"paymentMethodId":{"type":"string","format":"uuid","x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the payment method identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the identifier of a previously saved ACH account to charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\nThis field is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"style":{"color":"red"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"`paymentMethodDetails`"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":".\nProvide exactly one.\n"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set, the parent request's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillingAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContactInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional (the stored payment method carries this data)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 39a95e35-6d50-45ec-884b-c2417edf005d"},"children":[]}]}]}],"example":"39a95e35-6d50-45ec-884b-c2417edf005d"},"paymentMethodDetails":{"$ref":"#/components/schemas/PaymentMethodCardDetailsDto"}},"additionalProperties":false}},"components/schemas/AchDataDto":{"id":"components/schemas/AchDataDto","kind":"json-schema","title":"AchDataDto","data":{"required":["requesterIpAddress"],"type":"object","properties":{"paymentMethodId":{"type":"string","format":"uuid","x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the payment method identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the identifier of a previously saved ACH account to charge."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paymentMethodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\nThis field is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"style":{"color":"red"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"`paymentMethodDetails`"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":".\nProvide exactly one.\n"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set, the parent request's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BillingAddress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContactInfo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional (the stored payment method carries this data)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 39a95e35-6d50-45ec-884b-c2417edf005d"},"children":[]}]}]}],"example":"39a95e35-6d50-45ec-884b-c2417edf005d"},"paymentMethodDetails":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies an object describing the payment method details."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\nThis field is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"style":{"color":"red"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"`paymentMethodId`"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":".\nProvide exactly one.\n"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]}],"properties":{"accountNumber":{"$ref":"#/components/schemas/accountNumberRequest"},"routingNumber":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the ACH's account routing number.\n\nExample: 021000021\n","example":"021000021"},"accountHolderType":{"$ref":"#/components/schemas/AccountHolderType"},"accountType":{"$ref":"#/components/schemas/AccountType"},"taxId":{"type":"string","x-method":"request","description":"Specifies the tax identifier.\n\nExample: 12-3456789\n","example":"12-3456789","nullable":true}},"additionalProperties":false},"secCode":{"$ref":"#/components/schemas/AchSECCode"},"isSameDayProcessing":{"type":"boolean","nullable":true,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies same-day ACH processing for faster settlement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the transaction uses the same-day ACH processing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the transaction does not use the same-day ACH processing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null or omitted, the default standard ACH processing is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"requesterIpAddress":{"maxLength":45,"minLength":0,"type":"string","x-method":"request","description":"Specifies the IP address (in IPv4 or IPv6 format3) of the end user.\n\nThis end user may be the customer, operator, or application responsible for submitting the transaction.\nThis is required for audit and fraud-detection purposes.\n\nExample: 192.168.1.1\n","example":"192.168.1.1"}},"additionalProperties":false}},"components/schemas/TransactionDetailsDto":{"id":"components/schemas/TransactionDetailsDto","kind":"json-schema","title":"TransactionDetailsDto","data":{"type":"object","properties":{"cardData":{"$ref":"#/components/schemas/CardDataDto"},"achData":{"$ref":"#/components/schemas/AchDataDto"}},"additionalProperties":false}},"components/schemas/MobilePlatform":{"id":"components/schemas/MobilePlatform","kind":"json-schema","title":"MobilePlatform","data":{"enum":["iOS","Android"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the platform of the mobile phone."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Android"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mobile operating system by Google."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"iOS"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mobile operating system by Apple."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: iOS"},"children":[]}]}]}],"example":"iOS"}},"components/schemas/CreateTransactionRequestDto":{"id":"components/schemas/CreateTransactionRequestDto","kind":"json-schema","title":"CreateTransactionRequestDto","data":{"type":"object","properties":{"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"},"baseAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the base transaction amount before adjustments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"125"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"125.5"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"125.50"},"children":[]}]}]}],"example":125.5},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"referenceId":{"type":"string","x-method":"request","nullable":true,"minLength":0,"maxLength":36,"description":"Specifies a reference identifier provided by the merchant.\n\nThis is included in the duplicate-check key.\nIt allows the same card and amount combination to be charged multiple times when the reference identifiers are different.\n\nExample: REF-EXT-12345\n","example":"REF-EXT-12345"},"isCustomerInitiatedTransaction":{"type":"boolean","x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a transaction is initiated by a customer or a merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the transaction is initiated by customer."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the transaction is initiated by a merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"pricingType":{"$ref":"#/components/schemas/PricingType"},"extraAmounts":{"$ref":"#/components/schemas/ExtraAmountsDto"},"transactionEnhancedData":{"$ref":"#/components/schemas/TransactionEnhancedDataDto"},"billingAddress":{"$ref":"#/components/schemas/AddressDto"},"shippingAddress":{"$ref":"#/components/schemas/AddressDto"},"contactInfo":{"$ref":"#/components/schemas/ContactInfoDto"},"transactionDetails":{"$ref":"#/components/schemas/TransactionDetailsDto"},"deviceId":{"type":"string","format":"uuid","x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a device identifier from mobile app."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If included and the device has a linked user profile, the transaction is attributed to that user."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null or omitted, no attribution is made."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example: 088642a8-9082-4496-be63-8120765c5ad3"},"children":[]}]}]}],"example":"088642a8-9082-4496-be63-8120765c5ad3"},"platform":{"$ref":"#/components/schemas/MobilePlatform"},"appVersion":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the version of the mobile app used to process the transaction.\n\nExample: 1.4.2\n","example":"1.4.2"},"sdkVersion":{"type":"string","nullable":true,"x-method":"request","description":"Specifies the version of the SDK used to process the transaction.\n\nExample: 2.0.1\n","example":"2.0.1"}},"additionalProperties":false}},"components/schemas/refundDetals":{"id":"components/schemas/refundDetals","kind":"json-schema","title":"refundDetals","data":{"type":"object","properties":{"refundedAmount":{"type":"number","format":"double","multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the total amount (in USD) already refunded against this transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"56.99"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0"},"children":[]}]}]}],"example":0},"availableRefundAmount":{"type":"number","format":"double","multipleOf":0.01,"description":"Indicates the amount (in USD) still refundable.\n\nExample: 120.99\n","example":120.99},"isFullyRefunded":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the amount has been fully refunded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the amount has been fully refunded."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the amount has not been fully refunded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true}},"additionalProperties":false,"description":"Indicates an object detailing the refund posture for a transaction that can be refunded.\n\nThis value is null on transactions that are themselves refunds or credits.\nThose cannot be refunded again.\n"}},"components/schemas/TransactionCardDetailsDto":{"id":"components/schemas/TransactionCardDetailsDto","kind":"json-schema","title":"TransactionCardDetailsDto","data":{"type":"object","description":"Indicates the card details exposed on transaction responses.\n\nThese may be masked for sensitive fields or fully displayed for non-sensitive fields.\n","properties":{"paymentMethodId":{"$ref":"#/components/schemas/paymentMethodIdResponse"},"maskedCardNumber":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the masked card number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This displays only the last four numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: ************1111"},"children":[]}]}]}],"example":"************1111"},"cardBrand":{"$ref":"#/components/schemas/CardType"},"cardType":{"$ref":"#/components/schemas/CreditDebitType"},"cardProcessedAsType":{"$ref":"#/components/schemas/CreditDebitType"},"cardDataSource":{"$ref":"#/components/schemas/CardDataSourceDto"},"cardholderVerificationMethod":{"$ref":"#/components/schemas/CardholderAuthenticationMethodDto"},"emvTags":{"$ref":"#/components/schemas/TransactionReceiptDtoEmvTagsDto"}},"additionalProperties":false}},"components/schemas/AchDetailsDto":{"id":"components/schemas/AchDetailsDto","kind":"json-schema","title":"AchDetailsDto","data":{"type":"object","description":"Indicates ACH account details exposed on transaction responses.\n\nThese may be masked for sensitive fields or fully displayed for non-sensitive fields.\n","properties":{"paymentMethodId":{"$ref":"#/components/schemas/paymentMethodIdResponse"},"maskedAccountNumber":{"type":"string","nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the masked ACH account number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This displays only the last four numbers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: **************89"},"children":[]}]}]}],"example":"**************89"},"accountRoutingNumber":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the masked ACH routing number.\n\nExample: 123123123\n","example":"123123123"},"accountHolderType":{"$ref":"#/components/schemas/AccountHolderType"},"accountType":{"$ref":"#/components/schemas/AccountType"},"secCode":{"$ref":"#/components/schemas/AchSECCode"},"isSameDayProcessing":{"type":"boolean","nullable":true,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates same-day ACH processing for faster settlement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the transaction uses the same-day ACH processing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the transaction does not use the same-day ACH processing."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null or omitted, the default standard ACH processing is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"requesterIpAddress":{"maxLength":45,"minLength":0,"type":"string","x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the IP address of the end user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid IP address formats are:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IPv4"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IPv6 format3"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This end user may be the customer, operator, or application responsible for submitting the transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is required for audit and fraud-detection purposes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 192.168.1.1"},"children":[]}]}]}],"example":"192.168.1.1"}},"additionalProperties":false}},"components/schemas/declineDetails":{"id":"components/schemas/declineDetails","kind":"json-schema","title":"declineDetails","data":{"type":"object","description":"Indicates an object detailing a declined or failed transaction.\nThis value is null when the transaction was approved or is pending.\n","properties":{"code":{"type":"string","nullable":true,"description":"Indicates the decline or failure code from the processor or gateway.\n\nExample: 41\n","example":41},"message":{"type":"string","nullable":true,"description":"Indicates a human-readable decline or failure message.\n\nExample: Do Not Honor\n","example":"Do Not Honor"}},"additionalProperties":false}},"components/schemas/TransactionDetailEventTypesArray":{"id":"components/schemas/TransactionDetailEventTypesArray","kind":"json-schema","title":"TransactionDetailEventTypesArray","data":{"type":"array","x-method":"response","nullable":true,"description":"Indicates an object detailing the chronological list of events that occurred for this transaction.\n","items":{"type":"object","additionalProperties":false,"properties":{"transactionEventType":{"type":"string","x-method":"response","enum":["Authorization","Sale","Capture","Void","Refund","TipAdjustment","CardAuthentication","Hold","UnHold","Credit","Settle"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the type of the event."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorizes the transaction."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Capture"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collects funds from an approved authorization."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CardAuthentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirms cardholder identity before payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends funds back to a cardholder outside a refund."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hold"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pauses a transaction or account temporarily."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refund"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns funds for a completed sale."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sale"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorizes and captures payment in one step."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settle"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submits a batch for final processing."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TipAdjustment"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds or changes a tip after the sale."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UnHold"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes a hold and resumes normal activity."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Void"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a transaction before it settles."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Authorization"},"children":[]}]}]}],"example":"Authorization"},"transactionEventStatus":{"type":"string","x-method":"response","enum":["Pending","Approved","Declined","Failed"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the status of the event."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The processor approved the event."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The processor declined the event."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event ended in an error before a processor decision."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event is waiting for a result."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Approved"},"children":[]}]}]}],"example":"Approved"},"transactionEventDateTime":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 date-time format) the event occurred.\n\nExample: 2026-06-15T14:30:00Z\n","example":"2026-06-15T14:30:00Z"},"processedAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"response","description":"Indicates the amount (in USD) processed for this event.\n\nExample: 120.99\n","example":120.99},"originalTransactionId":{"$ref":"#/components/schemas/originalTransactionId"},"declineDetails":{"type":"object","nullable":true,"x-method":"response","description":"Indicates an object detailing a declined or failed event.\n\nThis value is null when the event was approved or is pending.\n","properties":{"code":{"type":"string","nullable":true,"description":"Indicates the decline or failure code from the processor or gateway.\n\nExample: 41\n","example":"41"},"message":{"type":"string","nullable":true,"description":"Indicates a human-readable decline or failure message.\n\nExample: HOLD-CALL\n","example":"HOLD-CALL"}},"additionalProperties":false}}}}},"components/schemas/GetTransactionResponseDtoFull":{"id":"components/schemas/GetTransactionResponseDtoFull","kind":"json-schema","title":"GetTransactionResponseDtoFull","data":{"type":"object","properties":{"transactionId":{"type":"string","format":"uuid","x-method":"response","nullable":true,"description":"Indicates the attached transaction identifier.\n\nThis value is available after processing.\n\nExample: f01339ec-8184-48c7-b58d-0780d6499ef4\n","example":"f01339ec-8184-48c7-b58d-0780d6499ef4"},"transactionDateTime":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 date-time format) of the transaction.\n\nExample: 2026-05-05T14:30:42.938Z\n","example":"2026-05-05T14:30:42.938Z"},"transactionStatus":{"$ref":"#/components/schemas/AggregatedTransactionStatus"},"transactionType":{"$ref":"#/components/schemas/TransactionType"},"cardTokenType":{"$ref":"#/components/schemas/TokenType"},"paymentMethodType":{"$ref":"#/components/schemas/PaymentMethodType"},"referenceId":{"type":"string","x-method":"response","nullable":true,"minLength":0,"maxLength":36,"description":"Indicates a reference identifier provided by the merchant.\n\nThis is included in the duplicate-check key.\nIt allows the same card and amount combination to be charged multiple times when the reference identifiers are different.\n\nExample: REF-EXT-12345\n","example":"REF-EXT-12345"},"originalTransactionId":{"$ref":"#/components/schemas/originalTransactionId"},"processedAmount":{"$ref":"#/components/schemas/processedAmount"},"refundDetails":{"$ref":"#/components/schemas/refundDetals"},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"pricingType":{"$ref":"#/components/schemas/PricingType"},"merchantId":{"$ref":"#/components/schemas/merchantId"},"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"},"customerId":{"$ref":"#/components/schemas/customerId"},"batchId":{"$ref":"#/components/schemas/batchId"},"amountBreakdown":{"$ref":"#/components/schemas/AmountBreakdownDto"},"cardDetails":{"$ref":"#/components/schemas/TransactionCardDetailsDto"},"achDetails":{"$ref":"#/components/schemas/AchDetailsDto"},"processorDetails":{"$ref":"#/components/schemas/processorDetails"},"declineDetails":{"$ref":"#/components/schemas/declineDetails"},"addressVerificationServiceResponse":{"$ref":"#/components/schemas/TransactionAddressVerificationServiceResponseDto"},"transactionEvents":{"$ref":"#/components/schemas/TransactionDetailEventTypesArray"},"source":{"$ref":"#/components/schemas/source"}},"additionalProperties":false}},"components/schemas/CaptureRequestDto":{"id":"components/schemas/CaptureRequestDto","kind":"json-schema","title":"CaptureRequestDto","data":{"type":"object","properties":{"captureAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the amount to capture (in USD)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null or omitted, the full authorized amount is captured."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If an amount is specified, a partial amount is captured."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value must both:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Be greater than zero"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not exceed the remaining authorized amount."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"129.99"},"children":[]}]}]}],"example":129.99}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies an object describing the capture request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Omit amount or send empty body for full capture; set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"captureAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for partial capture."},"children":[]}]}]}]}},"components/schemas/ReversalRequestDto":{"id":"components/schemas/ReversalRequestDto","kind":"json-schema","title":"ReversalRequestDto","data":{"type":"object","properties":{"reversalAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"request","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the amount (in USD) to refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a value is provided, the refund is for partial card refunds only."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If null or omitted, the full transaction amount is refunded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not use this value for void operations and ACH refunds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 50.24"},"children":[]}]}]}],"example":50.24}},"additionalProperties":false,"description":"Request to refund, or reverse, a transaction.\n\nThe backend automatically determines whether to void or refund based on the transaction's settlement status.\n"}},"components/schemas/CreditDetailsDto":{"id":"components/schemas/CreditDetailsDto","kind":"json-schema","title":"CreditDetailsDto","data":{"type":"object","properties":{"cardData":{"$ref":"#/components/schemas/CardDataDto"},"achData":{"$ref":"#/components/schemas/AchDataDto"}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies credit payment method details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cardData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"achData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]}]}},"components/schemas/CreditRequestDto":{"id":"components/schemas/CreditRequestDto","kind":"json-schema","title":"CreditRequestDto","data":{"type":"object","description":"Request to create an unreferenced credit (card unreferenced refund or ACH credit).\n","properties":{"paymentProcessorId":{"$ref":"#/components/schemas/paymentprocessorid"},"baseAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"request","description":"Specifies the base transaction amount before adjustments.\n\nExample: 99.99\n","example":99.99},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"referenceId":{"type":"string","x-method":"request","nullable":true,"minLength":0,"maxLength":36,"description":"Specifies a reference identifier provided by the merchant.\n\nThis is included in the duplicate-check key.\nIt allows the same card and amount combination to be charged multiple times when the reference identifiers are different.\n\nExample: REF-EXT-12345\n","example":"REF-EXT-12345"},"creditDetails":{"$ref":"#/components/schemas/CreditDetailsDto"},"billingAddress":{"$ref":"#/components/schemas/AddressDto"},"shippingAddress":{"$ref":"#/components/schemas/AddressDto"},"contactInfo":{"$ref":"#/components/schemas/ContactInfoDto"},"customerId":{"$ref":"#/components/schemas/customerId"}},"additionalProperties":false}},"components/schemas/TipAdjustmentRequestDto":{"id":"components/schemas/TipAdjustmentRequestDto","kind":"json-schema","title":"TipAdjustmentRequestDto","data":{"type":"object","properties":{"tipAmount":{"type":"number","format":"double","x-method":"request","multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the absolute amount (in USD) of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 14.50 (for $14.50)"},"children":[]}]}]}],"example":14.5},"tipRate":{"type":"number","format":"double","x-method":"response","multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a percentage of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 18.50 (for 18.50%)"},"children":[]}]}]}],"example":18.5}},"additionalProperties":false,"description":"Request to adjust the tip amount on a card transaction."}},"components/schemas/ZeroCostProcessingOptionDto":{"id":"components/schemas/ZeroCostProcessingOptionDto","kind":"json-schema","title":"ZeroCostProcessingOptionDto","data":{"enum":["None","CashDiscount","DualPricing","Surcharge"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the ZCP (zero cost processing) options."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CashDiscount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Listed price includes a discount for cash payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DualPricing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Displays a separate price for cash and card."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"None"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No zero cost processing program applied."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Surcharge"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a fee to the card price at checkout."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: CashDiscount"},"children":[]}]}]}],"example":"CashDiscount"}},"components/schemas/CalculatedAmountDto":{"id":"components/schemas/CalculatedAmountDto","kind":"json-schema","title":"CalculatedAmountDto","data":{"type":"object","properties":{"baseAmount":{"$ref":"#/components/schemas/baseAmount"},"discountAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the discount amount (in USD) applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 22.5 (for $22.5)"},"children":[]}]}]}],"example":22.5},"discountRate":{"type":"number","format":"double","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the discount percent applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 18.5 (for 18.5%)"},"children":[]}]}]}],"example":18.5},"surchargeAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the surcharge amount (in USD) applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 12.75 (for $12.75)"},"children":[]}]}]}],"example":12.75},"surchargeRate":{"type":"number","format":"double","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the surcharge percent applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 8.25 (for 8.25%)"},"children":[]}]}]}],"example":8.25},"tipAmount":{"type":"number","format":"double","x-method":"response","multipleOf":0.01,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the absolute amount (in USD) of the tip to be added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount adds to the base amount of the original transaction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"That transaction must be authorized first ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /pay-api/v1/transactions/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 14.50 (for $14.50)"},"children":[]}]}]}],"example":14.5},"tipRate":{"type":"number","format":"double","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the tip percent applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 15.25 (for 15.25%)"},"children":[]}]}]}],"example":15.25},"totalAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"response","description":"Indicates the final total amount  (in USD).\n\nExample: 124.99\n","example":124.99}},"additionalProperties":false,"description":"Amount breakdown for a specific payment method."}},"components/schemas/CalculateAmountResponseDto":{"id":"components/schemas/CalculateAmountResponseDto","kind":"json-schema","title":"CalculateAmountResponseDto","data":{"type":"object","properties":{"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"zeroCostProcessingOption":{"$ref":"#/components/schemas/ZeroCostProcessingOptionDto"},"pricingType":{"$ref":"#/components/schemas/PricingType"},"cash":{"$ref":"#/components/schemas/CalculatedAmountDto"},"creditCard":{"$ref":"#/components/schemas/CalculatedAmountDto"},"debitCard":{"$ref":"#/components/schemas/CalculatedAmountDto"},"ach":{"$ref":"#/components/schemas/CalculatedAmountDto"}},"additionalProperties":false,"description":"Calculated transaction amounts for different payment methods."}},"components/schemas/SendReceiptRequestDto":{"id":"components/schemas/SendReceiptRequestDto","kind":"json-schema","title":"SendReceiptRequestDto","data":{"required":["hasCustomerConsent","recipient","shareBy"],"type":"object","properties":{"shareBy":{"type":"string","x-method":"request","format":"E.164","minLength":1,"maxLength":20,"pattern":"^(null|\\+\\d{1,20})$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the method that shares this receipt."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system sends the notification by email."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"None"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system does not send a notification."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sms"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system sends the notification by text message."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Sms"},"children":[]}]}]}],"example":"Sms"},"recipient":{"type":"string","x-method":"request","format":"E.164","minLength":1,"maxLength":20,"pattern":"^\\+[1-9][0-9]{0,14}$","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the customer's mobile phone number."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is required only for SMS messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A receipt can be sent to any phone number the customer provides at time of receipt."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: +14155552309"},"children":[]}]}]}],"example":"+14155552309"},"hasCustomerConsent":{"type":"boolean","x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the customer has consented to receive the SMS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer has consented to receive the SMS."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the customer has not consented to receive the SMS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true}},"additionalProperties":false,"description":"Request to send a transaction receipt by SMS."}},"components/schemas/WebhookEndpointStatusResponse":{"id":"components/schemas/WebhookEndpointStatusResponse","kind":"json-schema","title":"WebhookEndpointStatusResponse","data":{"enum":["Active","Inactive"],"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the endpoint status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook endpoint is enabled and available for use."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inactive"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook endpoint is disabled and not available for use."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It still exists but will not send event notifications. It may be re-activated. In contrast, a deleted webhook has been removed entirely and cannot be re-activated. A new webhook must be created."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Active"},"children":[]}]}]}],"example":"Active"}},"components/schemas/WebhookEventType":{"id":"components/schemas/WebhookEventType","kind":"json-schema","title":"WebhookEventType","data":{"enum":["api_key.created","api_key.deleted","invoice.created","invoice.paid","merchant.created","payment_session.completed","payment_session.created","quick_payment.created","quick_payment.paid","settlement.batch.completed","subscription.created","subscription.delinquent","subscription.paid","subscription.payment_failed","terminal.added","terminal.deactivated","terminal.out_of_paper","transaction.ach.cancelled","transaction.ach.charged_back","transaction.ach.cleared","transaction.ach.failed","transaction.ach.held","transaction.ach.in_progress","transaction.ach.refunded","transaction.ach.scheduled","transaction.card.authorized","transaction.card.captured","transaction.card.declined","transaction.card.failed","transaction.card.refunded","transaction.card.voided"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies events that are subscribed to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wire value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Group"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"api_key.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys (affiliate only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"api_key.deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An API key was revoked or deleted"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys (affiliate only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new invoice was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoices"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invoice.paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An invoice was marked as paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invoices"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"merchant.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new merchant account was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchants (affiliate only)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_session.completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment session reached a terminal state (completed, failed, or cancelled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Sessions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"payment_session.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A payment session was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Sessions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quick_payment.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A quick payment link was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quick Payments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"quick_payment.paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A quick payment link was paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quick Payments"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"settlement.batch.completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A batch settlement was processed and settled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription.created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new subscription was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription.delinquent"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription entered a delinquent state after repeated payment failures"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription.paid"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription payment was successfully collected"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription.payment_failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription payment attempt failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal.added"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A new terminal was registered to the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal.deactivated"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A terminal was deactivated on the account"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"terminal.out_of_paper"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A terminal paper roll is empty"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was cancelled before processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.charged_back"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was returned or charged back"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.cleared"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction successfully cleared"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction failed due to a processing error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.held"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was placed on hold for review"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.in_progress"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was submitted to the network"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.refunded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was refunded to the originator"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.ach.scheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An ACH transaction was created and scheduled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.authorized"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment authorization was approved"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.captured"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An authorized card payment was captured"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.declined"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment was declined by the issuer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment failed due to a processing error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.refunded"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card payment was refunded to the cardholder"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transaction.card.voided"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A card authorization was voided before capture"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Transactions"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[ \"transaction.card.captured\" ]"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[ \"transaction.card.captured\", \"transaction.card.authorized\" ]"},"children":[]}]}]}],"example":["transaction.card.captured","transaction.card.refunded","settlement.batch.completed",null]}},"components/schemas/GetWebhookEndpointIsvResponseDto":{"id":"components/schemas/GetWebhookEndpointIsvResponseDto","kind":"json-schema","title":"GetWebhookEndpointIsvResponseDto","data":{"type":"object","properties":{"endpointId":{"type":"string","format":"uuid","description":"Indicates the webhook endpoint identifier.\n\nExample: 9ab3d9e0-1f2a-4b3c-4d5e-6f7a8b9c0d36\n","example":"9ab3d9e0-1f2a-4b3c-4d5e-6f7a8b9c0d36"},"endpointName":{"type":"string","nullable":true,"maxLength":255,"description":"Indicates the display name for the webhook.\n\nThis is a free-formed name that is convenient to recognize.\n\nExample: Peppared Street Cafe's Reconciliation\n","example":"Peppared Street Cafe's Reconciliation"},"endpointUrl":{"type":"string","maxLength":2048,"nullable":true,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the HTTPS callback URL that receives webhook events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples: https://example.com/webhooks/pepparedstreetcafe"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]}],"example":"https://example.com/webhooks/pepparedstreetcafe"},"endpointStatus":{"$ref":"#/components/schemas/WebhookEndpointStatusResponse"},"eventTypes":{"$ref":"#/components/schemas/WebhookEventType"},"createdOn":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 UTC date-time format) the webhook was created on.\n\nExample: 2026-05-05T14:30:36.759Z\n","example":"2026-05-05T14:30:36.759Z"},"modifiedOn":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 UTC date-time format) the webhook was last modified.\n\nExample: 2026-07-10T03:22:47.918Z\n","example":"2026-07-10T03:22:47.918Z"}},"additionalProperties":false,"example":{"items":[{"endpointId":"633649fc-9d16-4d1b-98ec-73a3282427fc","endpointName":"Peppared Street Cafe's Reconciliation","endpointUrl":"https://example.com/webhooks/pepparedstreetcafe","endpointStatus":"Active","eventTypes":["transaction.card.captured","settlement.batch.completed"],"createdOn":"2026-05-05T14:30:36.759Z","modifiedOn":"2026-07-10T03:22:47.918Z"}]}}},"components/schemas/ListWebhookEndpointsIsvResponseDto":{"id":"components/schemas/ListWebhookEndpointsIsvResponseDto","kind":"json-schema","title":"ListWebhookEndpointsIsvResponseDto","data":{"type":"object","properties":{"data":{"type":"array","nullable":true,"x-method":"response","description":"Indicates an object list of webhook details.","items":{"$ref":"#/components/schemas/GetWebhookEndpointIsvResponseDto"}}},"additionalProperties":false}},"components/schemas/CreateWebhookEndpointIsvResponseDto":{"id":"components/schemas/CreateWebhookEndpointIsvResponseDto","kind":"json-schema","title":"CreateWebhookEndpointIsvResponseDto","data":{"type":"object","properties":{"endpointId":{"type":"string","format":"uuid","x-method":"response","description":"Indicates the webhook endpoint identifier.\n\nExample: 9ab3d9e0-1f2a-4b3c-4d5e-6f7a8b9c0d36\n","example":"9ab3d9e0-1f2a-4b3c-4d5e-6f7a8b9c0d36"},"endpointName":{"type":"string","nullable":true,"x-method":"response","maxLength":255,"description":"Indicates the display name for the webhook.\n\nThis is a free-formed name that is convenient to recognize.\n\nExample: Peppared Street Cafe's Reconciliation\n","example":"Peppared Street Cafe's Reconciliation"},"endpointUrl":{"type":"string","maxLength":2048,"nullable":true,"x-method":"response","description":"Indicates the HTTPS callback URL that receives webhook events.\n\nExample: https://example.com/webhooks/pepparedstreetcafe\n","example":"https://example.com/webhooks/pepparedstreetcafe"},"endpointStatus":{"$ref":"#/components/schemas/WebhookEndpointStatusResponse"},"hmacSecret":{"type":"string","nullable":true,"x-method":"response","description":"Indicates the HMAC signing secret used to verify webhook payloads.\n\nThis value is returned only on creation and is never shown again.\n"},"eventTypes":{"$ref":"#/components/schemas/WebhookEventType"},"createdOn":{"type":"string","format":"date-time","x-method":"response","description":"Indicates the date-time (in an ISO 8601 UTC date-time format) the webhook was created on.\n\nExample: 2026-01-15T10:30:56.264Z\n","example":"2026-01-15T10:30:56.264Z"}},"additionalProperties":false}},"components/schemas/updatewebhookendpointisvrequestdto":{"id":"components/schemas/updatewebhookendpointisvrequestdto","kind":"json-schema","title":"updatewebhookendpointisvrequestdto","data":{"type":"object","properties":{"endpointName":{"type":"string","nullable":true,"maxLength":255,"description":"Specifies the display name for the webhook.\n\nThis is a free-formed name that is convenient to recognize.\n\nExample: Peppared Street Cafe's Reconciliation\n","example":"Peppared Street Cafe's Reconciliation"},"endpointUrl":{"type":"string","maxLength":2048,"nullable":true,"x-method":"request","description":"Specifies the HTTPS callback URL that receives webhook events.\n\nExample: https://example.com/webhooks/pepparedstreetcafe\n","example":"https://example.com/webhooks/pepparedstreetcafe"},"endpointStatus":{"type":"string","enum":["Active","Inactive"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the webhook state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Active"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook endpoint is enabled and available for use."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inactive"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook endpoint is disabled and not available for use."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It still exists but will not send event notifications. It may be re-activated. In contrast, a deleted webhook has been removed entirely and cannot be re-activated. A new webhook must be created."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any delivery attempts still queued for an endpoint that becomes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Inactive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is force-terminated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than retried again."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inactive endpoints can still be pinged manually."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Active"},"children":[]}]}]}],"example":"Active"},"eventTypes":{"$ref":"#/components/schemas/WebhookEventType"}},"additionalProperties":false}},"components/schemas/pingwebhookisvresponsedto":{"id":"components/schemas/pingwebhookisvresponsedto","kind":"json-schema","title":"pingwebhookisvresponsedto","data":{"type":"object","properties":{"isDelivered":{"type":"boolean","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the ping was delivered successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the ping was delivered successfully."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the ping was not delivered successfully."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: true"},"children":[]}]}]}],"example":true},"endpointHTTPResponseCode":{"type":"integer","format":"int32","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the HTTP response status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the HTTP status code returned by the attempted delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is a list of HTTP response status codes that include but are not limited to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery succeeded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint not found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limited"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 200"},"children":[]}]}]}],"example":200},"roundTripDurationMs":{"type":"integer","format":"int32","description":"Indicates the round-trip duration (in milliseconds).\n\nExample: 367\n","example":367},"errorMessage":{"type":"string","nullable":true,"description":"Indicates an error message if the delivery failed.\n\nExample: Recipient not available\n","example":"Recipient not available"}},"additionalProperties":false}},"components/schemas/webhookdeliverylogstatus":{"id":"components/schemas/webhookdeliverylogstatus","kind":"json-schema","title":"webhookdeliverylogstatus","data":{"type":"string","enum":["Success","Failure"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the webhook delivery log status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explanation"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook delivery attempt did not succeed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook delivery attempt succeeded."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: Success"},"children":[]}]}]}],"example":"Success"}},"components/schemas/webhookdeliverylogisvsummarydto":{"id":"components/schemas/webhookdeliverylogisvsummarydto","kind":"json-schema","title":"webhookdeliverylogisvsummarydto","data":{"type":"object","properties":{"deliveryLogId":{"type":"string","format":"uuid","description":"Indicates the webhook delivery log identifier to retrieve.\n\nExample: 89a2c8d9-0e1f-4a2b-3c4d-5e6f7a8b9c25\n","example":"89a2c8d9-0e1f-4a2b-3c4d-5e6f7a8b9c25"},"endpointId":{"type":"string","format":"uuid","description":"Indicates the webhook endpoint identifier.\n\nExample: 9ab3d9e0-1f2a-4b3c-4d5e-6f7a8b9c0d36\n","example":"9ab3d9e0-1f2a-4b3c-4d5e-6f7a8b9c0d36"},"endpointName":{"type":"string","nullable":true,"description":"Indicates the display name for the webhook.\n\nThis is a free-formed name that is convenient to recognize.\n\nExample: Peppared Street Cafe's Reconciliation\n","example":"Peppared Street Cafe's Reconciliation"},"endpointUrl":{"type":"string","maxLength":2048,"nullable":true,"x-method":"response","description":"Indicates the HTTPS callback URL that receives webhook events.\n\nExample: https://example.com/webhooks/pepparedstreetcafe\n","example":"https://example.com/webhooks/pepparedstreetcafe"},"eventId":{"type":"string","format":"uuid","description":"Indicates the event identifier.\n\nExample: 399f9d7d-0714-453c-9b6d-dda836e1d8e6\n","example":"399f9d7d-0714-453c-9b6d-dda836e1d8e6"},"eventType":{"$ref":"#/components/schemas/WebhookEventType"},"attemptNumber":{"type":"integer","format":"int32","description":"Indicates the current delivery attempt number for the webhook.\n\nExample: 3\n","example":3},"status":{"$ref":"#/components/schemas/webhookdeliverylogstatus"},"endpointHTTPResponseCode":{"type":"integer","format":"int32","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the HTTP response status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the HTTP status code returned by the attempted delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is a list of HTTP response status codes that include but are not limited to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery succeeded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint not found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limited"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 200"},"children":[]}]}]}],"example":200},"roundTripDurationMs":{"type":"integer","format":"int32","description":"Indicates the round-trip duration (in milliseconds).\n\nExample: 367\n","example":367},"errorMessage":{"type":"string","nullable":true,"description":"Indicates an error message if the delivery failed.\n\nExample: Recipient not available\n","example":"Recipient not available"},"createdOn":{"type":"string","format":"date-time","description":"Indicates the date-time (in an ISO 8601 UTC date-time format) the webhook was created on.\n\nExample: 2025-01-27T12:05:54.322Z\n","example":"2025-01-27T12:05:54.322Z"}},"additionalProperties":false}},"components/schemas/listwebhookdeliverylogsisvresponsedto":{"id":"components/schemas/listwebhookdeliverylogsisvresponsedto","kind":"json-schema","title":"listwebhookdeliverylogsisvresponsedto","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/webhookdeliverylogisvsummarydto"},"nullable":true},"pageInfo":{"$ref":"#/components/schemas/pageInfo"}},"additionalProperties":false}},"components/schemas/webhookdeliverylogisvdetaildto":{"id":"components/schemas/webhookdeliverylogisvdetaildto","kind":"json-schema","title":"webhookdeliverylogisvdetaildto","data":{"type":"object","properties":{"deliveryLogId":{"type":"string","format":"uuid","description":"Indicates the webhook delivery log identifier to retrieve.\n\nExample: 89a2c8d9-0e1f-4a2b-3c4d-5e6f7a8b9c25\n","example":"89a2c8d9-0e1f-4a2b-3c4d-5e6f7a8b9c25"},"endpointId":{"type":"string","format":"uuid","description":"Indicates the webhook endpoint identifier.\n\nExample: 9ab3d9e0-1f2a-4b3c-4d5e-6f7a8b9c0d36\n","example":"9ab3d9e0-1f2a-4b3c-4d5e-6f7a8b9c0d36"},"endpointName":{"type":"string","nullable":true,"description":"Indicates the display name for the webhook.\n\nThis is a free-formed name that is convenient to recognize.\n\nExample: Peppared Street Cafe's Reconciliation\n","example":"Peppared Street Cafe's Reconciliation"},"endpointUrl":{"type":"string","maxLength":2048,"x-method":"response","nullable":true,"description":"Indicates the HTTPS callback URL that receives webhook events.\n\nExample: https://example.com/webhooks/pepparedstreetcafe\n","example":"https://example.com/webhooks/pepparedstreetcafe"},"eventId":{"type":"string","format":"uuid","description":"Indicates the event identifier.\n\nExample: 399f9d7d-0714-453c-9b6d-dda836e1d8e6\n","example":"399f9d7d-0714-453c-9b6d-dda836e1d8e6"},"eventType":{"$ref":"#/components/schemas/WebhookEventType"},"attemptNumber":{"type":"integer","format":"int32","description":"Indicates the current delivery attempt number for the webhook.\n\nExample: 3\n","example":3},"deliveryLogStatus":{"$ref":"#/components/schemas/webhookdeliverylogstatus"},"endpointHTTPResponseCode":{"type":"integer","format":"int32","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the HTTP response status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the HTTP status code returned by the attempted delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is a list of HTTP response status codes that include but are not limited to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery succeeded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint not found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limited"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 200"},"children":[]}]}]}],"example":200},"roundTripDurationMs":{"type":"integer","format":"int32","description":"Indicates the round-trip duration (in milliseconds).\n\nExample: 367\n","example":367},"errorMessage":{"type":"string","nullable":true,"description":"Indicates an error message if the delivery failed.\n\nExample: Recipient not available\n","example":"Recipient not available"},"createdOn":{"type":"string","format":"date-time","description":"Indicates the date-time (in an ISO 8601 UTC date-time format) the webhook was created on.\n\nExample: 2025-01-27T12:05:54.322Z\n","example":"2025-01-27T12:05:54.322Z"},"nextRetryAt":{"type":"string","format":"date-time","nullable":true,"description":"Indicates the timestamp (in an ISO 8601 date-time UTC format) of the next retry attempt.\n\nThis value may be null if an attempt succeeded or there is no next retry attempt.\n\nExample: 2026-02-19T20:24:52.934Z\n","example":"2026-02-19T20:24:52.934Z"},"requestHeaders":{"type":"object","nullable":true,"description":"Indicates an object describing the request headers.\n","additionalProperties":{"type":"string","nullable":true,"description":"This object may not contain fields that are predefined.\n\nReview the actual returned fields for names and values.\n"}},"requestBody":{"type":"string","nullable":true,"description":"Indicates the request body.\n"},"responseHeaders":{"type":"object","nullable":true,"description":"Indicates an object describing the response headers.\n","additionalProperties":{"type":"string","nullable":true,"description":"This object may not contain fields that are predefined.\n\nReview the actual returned fields for names and values.\n"}},"responseBody":{"type":"string","nullable":true,"description":"Indicates the response body.\n"}},"additionalProperties":false}},"components/schemas/retrywebhookdeliveryisvresponsedto":{"id":"components/schemas/retrywebhookdeliveryisvresponsedto","kind":"json-schema","title":"retrywebhookdeliveryisvresponsedto","data":{"type":"object","properties":{"deliveryLogId":{"type":"string","format":"uuid","description":"Indicates the webhook delivery log identifier to retrieve.\n\nExample: 89a2c8d9-0e1f-4a2b-3c4d-5e6f7a8b9c25\n","example":"89a2c8d9-0e1f-4a2b-3c4d-5e6f7a8b9c25"},"endpointId":{"type":"string","format":"uuid","description":"Indicates the webhook endpoint identifier.\n\nExample: 9ab3d9e0-1f2a-4b3c-4d5e-6f7a8b9c0d36\n","example":"9ab3d9e0-1f2a-4b3c-4d5e-6f7a8b9c0d36"},"endpointName":{"type":"string","nullable":true,"maxLength":255,"description":"Indicates the display name for the webhook.\n\nThis is a free-formed name that is convenient to recognize.\n\nExample: Peppared Street Cafe's Reconciliation\n","example":"Peppared Street Cafe's Reconciliation"},"endpointUrl":{"type":"string","maxLength":2048,"x-method":"response","description":"Indicates the HTTPS callback URL that receives webhook events.\n\nExample: https://example.com/webhooks/pepparedstreetcafe\n","example":"https://example.com/webhooks/pepparedstreetcafe","nullable":true},"eventId":{"type":"string","format":"uuid","description":"Indicates the event identifier.\n\nExample: 399f9d7d-0714-453c-9b6d-dda836e1d8e6\n","example":"399f9d7d-0714-453c-9b6d-dda836e1d8e6"},"eventType":{"$ref":"#/components/schemas/WebhookEventType"},"deliveryLogStatus":{"$ref":"#/components/schemas/webhookdeliverylogstatus"},"attemptNumber":{"type":"integer","format":"int32","description":"Indicates the current delivery attempt number for the webhook.\n\nExample: 3\n","example":3},"endpointHTTPResponseCode":{"type":"integer","format":"int32","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the HTTP response status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the HTTP status code returned by the attempted delivery."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following is a list of HTTP response status codes that include but are not limited to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Meaning"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delivery succeeded"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad request"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint not found"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limited"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 200"},"children":[]}]}]}],"example":200},"roundTripDurationMs":{"type":"integer","format":"int32","description":"Indicates the round-trip duration (in milliseconds).\n\nExample: 367\n","example":367},"errorMessage":{"type":"string","nullable":true,"description":"Indicates an error message if the delivery failed.\n\nExample: Recipient not available\n","example":"Recipient not available"},"createdOn":{"type":"string","format":"date-time","description":"Indicates the date-time (in an ISO 8601 UTC date-time format) the webhook was created on.\n\nExample: 2025-01-27T12:05:54.322Z\n","example":"2025-01-27T12:05:54.322Z"},"nextRetryAt":{"type":"string","format":"date-time","nullable":true,"description":"Indicates the timestamp (in an ISO 8601 date-time UTC format) of the next retry attempt.\n\nThis value may be null if an attempt succeeded or there is no next retry attempt.\n\nExample: 2026-02-19T20:24:52.934Z\n","example":"2026-02-19T20:24:52.934Z"},"requestHeaders":{"type":"object","nullable":true,"description":"Indicates an object describing the request headers.\n","additionalProperties":{"type":"string","nullable":true,"description":"This object may not contain fields that are predefined.\n\nReview the actual returned fields for names and values.\n"}},"requestBody":{"type":"object","nullable":true,"description":"Indicates an object describing the request body.\n","additionalProperties":{"type":"string","nullable":true,"description":"This object may not contain fields that are predefined.\n\nReview the actual returned fields for names and values.\n"}},"responseHeaders":{"type":"object","nullable":true,"description":"Indicates an object describing the response headers.\n","additionalProperties":{"type":"string","nullable":true,"description":"This object may not contain fields that are predefined.\n\nReview the actual returned fields for names and values.\n"}},"responseBody":{"type":"object","nullable":true,"description":"Indicates an object describing the response body.\n","additionalProperties":{"type":"string","nullable":true,"description":"This object may not contain fields that are predefined.\n\nReview the actual returned fields for names and values.\n"}}},"additionalProperties":false}},"schema_188":{"kind":"json-schema","data":{"oneOf":[{"type":"object","title":"Obtain a new token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to obtain a brand-new API token from your API key."},"children":[]}]}]}],"required":["client_id","client_secret","grant_type","scope"],"properties":{"client_id":{"type":"string","description":"Specifies client ID from the API key for the account.\n\nExample: 59483870959438697242c\n","example":"59483870959438697242c"},"client_secret":{"type":"string","description":"Specifies the client secret from the API key for the account.\n\nExample: 9eb2c6859daa4d8ae5da02a9\n","example":"9eb2c6859daa4d8ae5da02a9"},"grant_type":{"type":"string","enum":["client_credentials"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the literal value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: client_credentials"},"children":[]}]}]}],"example":"client_credentials"},"scope":{"type":"string","enum":["offline_access"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the literal value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offline_access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: offline_access"},"children":[]}]}]}],"example":"offline_access"}}},{"type":"object","title":"Refresh an existing token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a prior "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to get a new API token without re-authenticating."},"children":[]}]}]}],"required":["client_id","client_secret","grant_type","refresh_token"],"properties":{"client_id":{"type":"string","description":"Specifies client ID from the API key for the account.\n\nExample: 59483870959438697242c\n","example":"59483870959438697242c"},"client_secret":{"type":"string","description":"Specifies the client secret from the API key for the account.\n\nExample: 9eb2c6859daa4d8ae5da02a9\n","example":"9eb2c6859daa4d8ae5da02a9"},"grant_type":{"type":"string","enum":["refresh_token"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the literal value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: refresh_token"},"children":[]}]}]}],"example":"refresh_token"},"refresh_token":{"type":"string","description":"Specifies the refresh token received from a prior token request.\n\nExample: YhjQpM...EVkVuB\n","example":"YhjQpM...EVkVuB"}}}]},"id":"schema_188"},"schema_189":{"kind":"json-schema","data":{"type":"object","required":["access_token","token_type"],"properties":{"access_token":{"type":"string","description":"Indicates the API token.\n\nExample: 213bf7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14\n","example":"213bf7a8-9b0c-4d1e-2f3a-4b5c6d7e8f14"},"token_type":{"type":"string","description":"Indicates the token type.\n\nExample: Bearer\n","example":"Bearer"},"expires_in":{"type":"integer","description":"Indicates the expiry, or lifetime, (in seconds) of the API token.\n\nExample: 900\n","example":900},"refresh_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the refresh token (only for authorization_code grant)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 324c08b9-0c1d-4e2f-3a4b-5c6d7e8f9a25"},"children":[]}]}]}],"example":"324c08b9-0c1d-4e2f-3a4b-5c6d7e8f9a25"},"scope":{"type":"string","description":"Indicates the granted scopes, space-delimited.\n\nExample: null\n","example":null}}},"id":"schema_189"},"schema_190":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0,"minimum":0,"x-method":"query"},"id":"schema_190"},"schema_191":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":20,"minimum":1,"maximum":100,"x-method":"query"},"id":"schema_191"},"schema_192":{"kind":"json-schema","data":{"type":"boolean","default":true,"x-method":"query"},"id":"schema_192"},"schema_193":{"kind":"json-schema","data":{"type":"string","x-method":"query"},"id":"schema_193"},"schema_194":{"kind":"json-schema","data":{"type":"string","x-method":"query","example":"Alexandro Peppared"},"id":"schema_194"},"schema_195":{"kind":"json-schema","data":{"type":"string","x-method":"query","example":"pepparedstreetcafe@example.com"},"id":"schema_195"},"schema_196":{"kind":"json-schema","data":{"type":"string","x-method":"query","example":"Peppared Street Cafe"},"id":"schema_196"},"schema_197":{"kind":"json-schema","data":{"type":"string","x-method":"query","example":"+14155552309"},"id":"schema_197"},"schema_198":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2026-02-19T20:24:52.934Z"},"id":"schema_198"},"schema_199":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2026-03-06T14:24:52.934Z"},"id":"schema_199"},"schema_200":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"c4b210e9-be39-4ebc-8195-0c422de87f90"},"id":"schema_200"},"schema_201":{"kind":"json-schema","data":{"type":"string","format":"uuid","x-method":"QUERY","example":"8db2ff47-b143-4adb-ab58-a4a017504db2"},"id":"schema_201"},"schema_202":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"aa98aa89-07ae-4a23-b441-48725f0386e6"},"id":"schema_202"},"schema_203":{"kind":"json-schema","data":{"type":"string","x-method":"query","example":"Conners Electric"},"id":"schema_203"},"schema_204":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"c24e0199-7e8e-49b0-ac09-16aae93af4be"},"id":"schema_204"},"schema_205":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"c857af4c-ced9-4b79-b39b-13c077711d7e"},"id":"schema_205"},"schema_206":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"a6ae6a86-6831-4422-a646-d9442a1b0ec8"},"id":"schema_206"},"schema_207":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"1a4f15c9-f39c-49f1-aad5-04e0e72804ad"},"id":"schema_207"},"schema_208":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"edf7b36a-1b2c-4d3e-4f5a-6b7c8d9e0f36"},"id":"schema_208"},"schema_209":{"kind":"json-schema","data":{"type":"string","x-method":"query","default":"asc"},"id":"schema_209"},"schema_210":{"kind":"json-schema","data":{"type":"string","format":"uuid","x-method":"query","example":"57dbdbc6-fef4-44b8-816a-4372c063f1ec"},"id":"schema_210"},"schema_211":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2025-01-27T12:05:54.322Z"},"id":"schema_211"},"schema_212":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2026-02-27T12:05:54.322Z"},"id":"schema_212"},"schema_213":{"kind":"json-schema","data":{"enum":["InProgress","Completed","Cancelled","Failed"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the POS transaction status to filter by,"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancelled"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POS transaction was canceled before it completed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POS transaction finished processing successfully."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POS transaction did not complete because of an error."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"InProgress"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The POS transaction is still being processed."},"children":[]}]}]}]}]}]}]},"id":"schema_213"},"schema_214":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"361c152f-72fa-4654-84f1-a664584ce3de"},"id":"schema_214"},"schema_215":{"kind":"json-schema","data":{"type":"boolean","x-method":"query","default":false},"id":"schema_215"},"schema_216":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"bc037464-05f0-4cc6-b1d9-66d44636a1a1"},"id":"schema_216"},"schema_217":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"6b486f55-e922-4a34-90c0-c78c75055eb1"},"id":"schema_217"},"schema_218":{"kind":"json-schema","data":{"type":"array","x-method":"query","items":{"type":"string","format":"uuid","example":"fe08c47b-2c3d-4e4f-5a6b-7c8d9e0f1a47"},"example":["fe08c47b-2c3d-4e4f-5a6b-7c8d9e0f1a47","0f19d58c-3d4e-4f5a-6b7c-8d9e0f1a2b58"]},"id":"schema_218"},"schema_219":{"kind":"json-schema","data":{"type":"array","x-method":"query","items":{"type":"string","format":"uuid","example":"1a2ae69d-4e5f-4a6b-7c8d-9e0f1a2b3c69"}},"id":"schema_219"},"schema_220":{"kind":"json-schema","data":{"type":"string","example":"Open"},"id":"schema_220"},"schema_221":{"kind":"json-schema","data":{"type":"string","example":"terminalManufacturer"},"id":"schema_221"},"schema_222":{"kind":"json-schema","data":{"enum":["Ready","Busy","Offline"],"type":"string"},"id":"schema_222"},"schema_223":{"kind":"json-schema","data":{"enum":["Standalone","SemiIntegrated"],"type":"string","example":"SemiIntegrated"},"id":"schema_223"},"schema_224":{"kind":"json-schema","data":{"enum":["Online","Offline"],"type":"string"},"id":"schema_224"},"schema_225":{"kind":"json-schema","data":{"type":"string","example":"SN100001"},"id":"schema_225"},"schema_226":{"kind":"json-schema","data":{"type":"string","example":"Peppared Street Cafe"},"id":"schema_226"},"schema_227":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"ad307589-17b9-4f8a-9489-6b4c48f0c40d"},"id":"schema_227"},"schema_228":{"kind":"json-schema","data":{"type":"string","example":"transactionDateTime"},"id":"schema_228"},"schema_229":{"kind":"json-schema","data":{"enum":["ApiKey","Invoice","MobileApp","Portal","QuickPayment","Subscription","TapToPay","Terminal","WebComponent"],"type":"string"},"id":"schema_229"},"schema_230":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"81915d04-1f2a-4b3c-4d5e-6f7a8b9c0d36"},"id":"schema_230"},"schema_231":{"kind":"json-schema","data":{"type":"string","example":"0b7aa955-6b52-4dcb-b0d8-7c3d82f27b62"},"id":"schema_231"},"schema_232":{"kind":"json-schema","data":{"type":"string","example":"Authorized","enum":["Authorized","Cancelled","Captured","ChargedBack","Cleared","Declined","Failed","Held","HeldByProcessor","Informational","InProgress","PartiallyAuthorized","Pending","Refunded","Scheduled","Settled","Verified","Voided"]},"id":"schema_232"},"schema_233":{"kind":"json-schema","data":{"type":"string","example":"Cash"},"id":"schema_233"},"schema_234":{"kind":"json-schema","data":{"type":"string","format":"uuid","x-method":"query","example":"8fa8e727-73c6-436e-b56f-6f55aabf3b1c"},"id":"schema_234"},"schema_235":{"kind":"json-schema","data":{"type":"string","format":"uuid","x-method":"query","example":"92a26e15-2a3b-4c4d-5e6f-7a8b9c0d1e47"},"id":"schema_235"},"schema_236":{"kind":"json-schema","data":{"type":"number","format":"double","multipleOf":0.01,"x-method":"query","example":500},"id":"schema_236"},"schema_237":{"kind":"json-schema","data":{"type":"string","nullable":true,"minLength":0,"maxLength":36,"x-method":"query","example":"REF-EXT-12345"},"id":"schema_237"},"schema_238":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"3c25d7e4-dfe0-4ede-a3f0-fb280cac281c"},"id":"schema_238"},"schema_239":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"487471b7-0149-44ed-840b-97d920e06829"},"id":"schema_239"},"schema_240":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"d4e39f93-a128-45f4-9b27-140042a5efa5"},"id":"schema_240"},"schema_241":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"487471b7-0149-44ed-840b-97d920e068"},"id":"schema_241"},"schema_242":{"kind":"json-schema","data":{"type":"object","properties":{"baseAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the base transaction amount before adjustments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"125"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"125.5"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"125.50"},"children":[]}]}]}],"example":125.5},"currencyCode":{"$ref":"#/components/schemas/currencyCode"},"pricingType":{"$ref":"#/components/schemas/PricingType"},"tipAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the absolute tip amount (in USD) to add."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 10.5 (as $10.5)"},"children":[]}]}]}],"example":10.5},"tipRate":{"type":"number","format":"double","x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the tip rate to apply."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encoded as raw percentage."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example: 18.5 for 18.5%."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tipRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 18.5 (as 18.5%)"},"children":[]}]}]}],"example":18.5},"discountAmount":{"type":"number","format":"double","multipleOf":0.01,"x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates the absolute amount (in USD) of discount to be applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 25 (for $25)"},"children":[]}]}]}],"example":25},"discountRate":{"type":"number","format":"double","x-method":"response","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates a percentage of a discount to be applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this value is provided, it must be greater than zero."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"className":"note"}},"children":[{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Care must be taken that a value other than zero can be provided to either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discountRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A non-zero value cannot be provided to both."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 5.5 (for 5.5%)"},"children":[]}]}]}],"example":5.5},"surchargeRate":{"type":"number","format":"double","x-method":"request","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the credit Card surcharge rate override."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: 2.5 (for 2.5%)"},"children":[]}]}]}],"example":2.5}}},"id":"schema_242"},"schema_243":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"e6d064c0-b2a5-4cb3-bc57-8135123ed791"},"id":"schema_243"},"schema_244":{"kind":"json-schema","data":{"enum":["Active","Inactive"],"type":"string","example":"Active"},"id":"schema_244"},"schema_245":{"kind":"json-schema","data":{"type":"object","required":["endpointName","endpointUrl","eventTypes"],"properties":{"endpointName":{"type":"string","maxLength":255,"description":"Specifies the display name for the webhook.\n\nThis is a free-formed name that is convenient to recognize.\n\nExample: Peppared Street Cafe's Reconciliation\n","example":"Peppared Street Cafe's Reconciliation"},"endpointUrl":{"type":"string","maxLength":2048,"x-method":"request","description":"Specifies the HTTPS callback URL that receives webhook events.\n\nExample: https://example.com/webhooks/pepparedstreetcafe\n","example":"https://example.com/webhooks/pepparedstreetcafe"},"eventTypes":{"$ref":"#/components/schemas/WebhookEventType"}},"additionalProperties":false},"id":"schema_245"},"schema_246":{"kind":"json-schema","data":{"type":"string","format":"uuid","required":true,"example":"0dab4e68-8d18-42ce-93ba-77b0e8dbafdc"},"id":"schema_246"},"schema_247":{"kind":"json-schema","data":{"type":"string","format":"uuid","required":true,"example":"76804cf3-4a5b-4c6d-7e8f-9a0b1c2d3e69"},"id":"schema_247"},"schema_248":{"kind":"json-schema","data":{"type":"string","format":"uuid","required":true,"example":"e8570526-3b2c-4776-ad1c-1303ccb5bc2d"},"id":"schema_248"},"schema_249":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_249"},"schema_250":{"kind":"json-schema","data":{"type":"string","enum":["api_key.created","api_key.deleted","invoice.created","invoice.paid","merchant.created","payment_session.completed","payment_session.created","quick_payment.created","quick_payment.paid","settlement.batch.completed","subscription.created","subscription.delinquent","subscription.paid","subscription.payment_failed","terminal.added","terminal.deactivated","terminal.out_of_paper","transaction.ach.cancelled","transaction.ach.charged_back","transaction.ach.cleared","transaction.ach.failed","transaction.ach.held","transaction.ach.in_progress","transaction.ach.refunded","transaction.ach.scheduled","transaction.card.authorized","transaction.card.captured","transaction.card.declined","transaction.card.failed","transaction.card.refunded","transaction.card.voided"]},"id":"schema_250"},"schema_251":{"kind":"json-schema","data":{"$ref":"#/components/schemas/webhookdeliverylogstatus"},"id":"schema_251"},"schema_252":{"kind":"json-schema","data":{"type":"integer","format":"int32","example":401},"id":"schema_252"},"schema_253":{"kind":"json-schema","data":{"type":"string"},"id":"schema_253"},"schema_254":{"kind":"json-schema","data":{"type":"string","format":"uuid","required":true,"example":"30d1d958-cf5a-446c-be96-5a78b2220c19"},"id":"schema_254"},"schema_255":{"kind":"json-schema","data":{"type":"string","format":"uuid","required":true,"example":"a9b37f26-7d8e-4f9a-0b1c-2d3e4f5a6b92"},"id":"schema_255"},"schema_256":{"kind":"json-schema","data":{"type":"integer","format":"int32","example":200},"id":"schema_256"},"schema_257":{"kind":"json-schema","data":{"type":"string","enum":["Csv","Json"],"default":"Csv","example":"Csv"},"id":"schema_257"},"schema_258":{"kind":"json-schema","data":{"type":"string","format":"byte","description":"Indicates the returned file in the specified format.\n"},"id":"schema_258"},"schema_259":{"kind":"json-schema","data":{"type":"string","format":"uuid","required":true,"example":"87915d04-5b6c-4d7e-8f9a-0b1c2d3e4f70"},"id":"schema_259"}},"exampleStore":{"paths/~1oauth2~1token/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1oauth2~1token/post/responses/400/content/application~1json/example"},"paths/~1oauth2~1token/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1oauth2~1token/post/responses/401/content/application~1json/example"},"paths/~1oauth2~1token/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1oauth2~1token/post/responses/500/content/application~1json/example"},"paths/~1v2~1customers/get/responses/200/content/application~1json/example":{"value":{"items":[{"customerId":"f81ca0b7-fa2e-4a6c-be9e-7def348c1ddf","externalId":"CUST-EXT-001","firstName":"John","lastName":"Doe","companyName":"Acme Corp","email":"john.doe@acme.com","mobilePhoneNumber":"+14125553845","billingAddress":{"city":"New York","countryCode":"US","addressLine1":"123 Main Street","addressLine2":null,"postalCode":"10001","stateCode":"NY"},"lastTransactionDate":"2026-05-29T22:04:31.771Z","paymentMethodsCount":3},{"customerId":"a98bbbba-40e6-4114-970a-078ebfdcbac2","externalId":"CUST-EXT-002","firstName":"Jane","lastName":"Smith","companyName":"Tech Solutions Inc","email":"jane.smith@techsolutions.com","mobilePhoneNumber":"+14155557890","billingAddress":{"city":"Los Angeles","countryCode":"US","addressLine1":"456 Oak Avenue","addressLine2":null,"postalCode":"90001","stateCode":"CA"},"lastTransactionDate":"2026-06-01T22:04:31.771Z","paymentMethodsCount":1}],"pageInfo":{"pageIndex":0,"pageSize":20,"totalItems":150,"totalPages":8,"hasMore":true}},"id":"paths/~1v2~1customers/get/responses/200/content/application~1json/example"},"paths/~1v2~1customers/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers/get/responses/400/content/application~1json/example"},"paths/~1v2~1customers/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers/get/responses/401/content/application~1json/example"},"paths/~1v2~1customers/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers/get/responses/403/content/application~1json/example"},"paths/~1v2~1customers/get/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers/get/responses/404/content/application~1json/example"},"paths/~1v2~1customers/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers/get/responses/429/content/application~1json/example"},"paths/~1v2~1customers/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers/get/responses/500/content/application~1json/example"},"paths/~1v2~1customers/post/requestBody/content/application~1json/example":{"value":{"firstName":"John","lastName":"Doe","companyName":"Acme Corp","email":"john.doe@acme.com","mobilePhoneNumber":"+14125553845","hasSmsConsent":true,"shouldUseBillingAsShippingAddress":false,"billingAddress":{"city":"New York","countryCode":"US","addressLine1":"123 Main Street","addressLine2":"Suite 100","postalCode":"10001","stateCode":"NY"},"shippingAddress":{"city":"Brooklyn","countryCode":"US","addressLine1":"456 Market Street","addressLine2":"Suite 7B","postalCode":"11201","stateCode":"NY"},"paymentMethodsCreditCards":[{"paymentName":"My Visa Card","cardNumber":"4111111111111111","securityCode":"123","expirationMonth":12,"expirationYear":2032}],"paymentMethodsAchAccounts":[{"paymentName":"Business Checking","routingNumber":"021000021","accountNumber":"123456789","taxId":"12-3456789","accountHolderType":"Personal","accountType":"Checking"}]},"id":"paths/~1v2~1customers/post/requestBody/content/application~1json/example"},"paths/~1v2~1customers/post/responses/200/content/application~1json/example":{"value":{"customerId":"e0bfe4be-c02a-4ded-bbdf-07a8bf8544c8"},"id":"paths/~1v2~1customers/post/responses/200/content/application~1json/example"},"paths/~1v2~1customers/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers/post/responses/400/content/application~1json/example"},"paths/~1v2~1customers/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers/post/responses/401/content/application~1json/example"},"paths/~1v2~1customers/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers/post/responses/403/content/application~1json/example"},"paths/~1v2~1customers/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers/post/responses/404/content/application~1json/example"},"paths/~1v2~1customers/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers/post/responses/429/content/application~1json/example"},"paths/~1v2~1customers/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers/post/responses/500/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/get/responses/200/content/application~1json/example":{"value":{"customerId":"61e5435f-7cec-4a7b-8523-64358cac7fac","externalId":"CUST-EXT-12345","firstName":"John","lastName":"Doe","companyName":"Acme Corp","email":"john.doe@acme.com","mobilePhoneNumber":"+14125553845","hasSmsConsent":true,"shouldUseBillingAsShippingAddress":true,"billingAddress":{"city":"New York","countryCode":"US","addressLine1":"123 Main Street","addressLine2":"Suite 100","postalCode":"10001","stateCode":"NY"},"shippingAddress":null,"lastTransactionDate":"2026-05-29T22:04:31.792Z","transactionsCount":25,"transactionsVolume":12500,"lastTransactionAmount":150,"numberOfSubscriptions":2,"cards":[{"cardMask":"************1111","expirationMonth":12,"expirationYear":2026,"cardTokenType":null,"cardType":"Visa","creditDebitType":"Credit","paymentMethodId":"e5348db9-85cf-4d9d-a27c-88013f8944be","paymentName":"My Visa Card","isDefault":true},{"cardMask":"************5555","expirationMonth":6,"expirationYear":2033,"cardTokenType":null,"cardType":"MasterCard","creditDebitType":"Debit","paymentMethodId":"911e5ed6-95db-4ceb-8c49-5dc997ce0b3d","paymentName":"Personal MasterCard","isDefault":false}],"achAccounts":[{"accountNumber":"****6789","routingNumber":"021000021","accountType":"Checking","accountHolderType":"Personal","taxId":"***-**-6789","paymentMethodId":"a7402e6f-7b52-4884-9214-b68dcd7b80bf","paymentName":"Business Checking","isDefault":false}]},"id":"paths/~1v2~1customers~1{customerId}/get/responses/200/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/get/responses/400/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/get/responses/401/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/get/responses/403/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/get/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/get/responses/404/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/get/responses/429/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/get/responses/500/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/patch/requestBody/content/application~1json/example":{"value":{"firstName":"Jane","lastName":"Smith","companyName":"Tech Solutions Inc","email":"jane.smith@techsolutions.com","mobilePhoneNumber":"+15559876543","hasSmsConsent":false,"shouldUseBillingAsShippingAddress":false,"billingAddress":{"city":"Los Angeles","countryCode":"US","addressLine1":"456 Oak Avenue","addressLine2":"Floor 5","postalCode":"90001","stateCode":"CA"},"shippingAddress":{"city":"San Francisco","countryCode":"US","addressLine1":"789 Pine Road","addressLine2":null,"postalCode":"94102","stateCode":"CA"}},"id":"paths/~1v2~1customers~1{customerId}/patch/requestBody/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/patch/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/patch/responses/400/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/patch/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/patch/responses/401/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/patch/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/patch/responses/403/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/patch/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/patch/responses/404/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/patch/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/patch/responses/409/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/patch/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/patch/responses/429/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/patch/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/patch/responses/500/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/delete/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/delete/responses/400/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/delete/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/delete/responses/401/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/delete/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/delete/responses/403/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/delete/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/delete/responses/404/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/delete/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/delete/responses/409/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/delete/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/delete/responses/429/content/application~1json/example"},"paths/~1v2~1customers~1{customerId}/delete/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1customers~1{customerId}/delete/responses/500/content/application~1json/example"},"paths/~1v2~1api-keys/get/responses/200/content/application~1json/example":{"value":{"apiKeys":[{"clientId":"80bb3659-9a62-470b-92f5-d8c5d16d47b0","merchantId":"886e77d0-e86f-4710-92f6-e2b84b29bd9e","apiKeyName":"Production API Key"},{"clientId":"7f191870-7de7-495a-9037-fabeefbdd089","merchantId":"9040dc53-46e3-4816-b3b3-c83d885c2b07","apiKeyName":"Staging API Key"}]},"id":"paths/~1v2~1api-keys/get/responses/200/content/application~1json/example"},"paths/~1v2~1api-keys/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/get/responses/400/content/application~1json/example"},"paths/~1v2~1api-keys/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/get/responses/401/content/application~1json/example"},"paths/~1v2~1api-keys/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/get/responses/403/content/application~1json/example"},"paths/~1v2~1api-keys/get/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/get/responses/404/content/application~1json/example"},"paths/~1v2~1api-keys/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/get/responses/429/content/application~1json/example"},"paths/~1v2~1api-keys/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/get/responses/500/content/application~1json/example"},"paths/~1v2~1api-keys/post/requestBody/content/application~1json/example":{"value":{"merchantId":"0b627967-4204-4d7a-aa13-e6eb0d58f543","apiKeyName":"Production API Key"},"id":"paths/~1v2~1api-keys/post/requestBody/content/application~1json/example"},"paths/~1v2~1api-keys/post/responses/200/content/application~1json/example":{"value":{"clientId":"97e7c13c-059c-4734-b017-2a20847a79d0","clientSecret":"1f80d6e1-9901-48b6-a862-6cfad1612e99"},"id":"paths/~1v2~1api-keys/post/responses/200/content/application~1json/example"},"paths/~1v2~1api-keys/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/post/responses/400/content/application~1json/example"},"paths/~1v2~1api-keys/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/post/responses/401/content/application~1json/example"},"paths/~1v2~1api-keys/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/post/responses/403/content/application~1json/example"},"paths/~1v2~1api-keys/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/post/responses/404/content/application~1json/example"},"paths/~1v2~1api-keys/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/post/responses/409/content/application~1json/example"},"paths/~1v2~1api-keys/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/post/responses/429/content/application~1json/example"},"paths/~1v2~1api-keys/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys/post/responses/500/content/application~1json/example"},"paths/~1v2~1api-keys~1{clientId}/delete/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys~1{clientId}/delete/responses/400/content/application~1json/example"},"paths/~1v2~1api-keys~1{clientId}/delete/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys~1{clientId}/delete/responses/401/content/application~1json/example"},"paths/~1v2~1api-keys~1{clientId}/delete/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys~1{clientId}/delete/responses/403/content/application~1json/example"},"paths/~1v2~1api-keys~1{clientId}/delete/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys~1{clientId}/delete/responses/409/content/application~1json/example"},"paths/~1v2~1api-keys~1{clientId}/delete/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys~1{clientId}/delete/responses/429/content/application~1json/example"},"paths/~1v2~1api-keys~1{clientId}/delete/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1api-keys~1{clientId}/delete/responses/500/content/application~1json/example"},"paths/~1v2~1payment-methods/get/responses/200/content/application~1json/example":{"value":{"items":[{"paymentMethodId":"8a06469f-25da-4763-990d-11a4bbc74ecb","customerId":"4f7d41f8-1d45-4cb7-a1e8-788fea6a2b11","name":"My Visa Card","type":"Card","isDefault":true,"createdOn":"2026-01-15T10:30:56.264Z","card":{"cardMask":"************1111","expirationMonth":12,"expirationYear":2033,"cardTokenType":"Local"},"ach":null},{"paymentMethodId":"7ada26ab-308a-4d2b-abb2-f0f69711ea38","customerId":null,"name":"Acme Bus Savings","type":"ElectronicCheck","isDefault":false,"createdOn":"2026-02-01T09:00:56.264Z","card":null,"ach":{"accountNumber":"****6789","routingNumber":"021000021","accountType":"Checking","accountHolderType":"Business","taxId":"***-**-6789","companyName":"Acme Corp Inc"}}],"pageInfo":{"pageIndex":0,"pageSize":20,"totalItems":150,"totalPages":8,"hasMore":true}},"id":"paths/~1v2~1payment-methods/get/responses/200/content/application~1json/example"},"paths/~1v2~1payment-methods/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods/get/responses/400/content/application~1json/example"},"paths/~1v2~1payment-methods/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods/get/responses/401/content/application~1json/example"},"paths/~1v2~1payment-methods/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods/get/responses/403/content/application~1json/example"},"paths/~1v2~1payment-methods/get/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods/get/responses/404/content/application~1json/example"},"paths/~1v2~1payment-methods/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods/get/responses/429/content/application~1json/example"},"paths/~1v2~1payment-methods/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods/get/responses/500/content/application~1json/example"},"paths/~1v2~1payment-methods~1cards/post/requestBody/content/application~1json/example":{"value":{"customerId":"098290e9-49cd-4613-a885-db61a29f80f7","paymentName":"My Visa Card","cardNumber":"4111111111111111","securityCode":"123","expirationMonth":12,"expirationYear":2030},"id":"paths/~1v2~1payment-methods~1cards/post/requestBody/content/application~1json/example"},"paths/~1v2~1payment-methods~1cards/post/responses/200/content/application~1json/example":{"value":{"paymentMethodId":"83eed29d-849d-4aff-8ff7-02783bfe97d5"},"id":"paths/~1v2~1payment-methods~1cards/post/responses/200/content/application~1json/example"},"paths/~1v2~1payment-methods~1cards/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1cards/post/responses/400/content/application~1json/example"},"paths/~1v2~1payment-methods~1cards/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1cards/post/responses/401/content/application~1json/example"},"paths/~1v2~1payment-methods~1cards/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1cards/post/responses/403/content/application~1json/example"},"paths/~1v2~1payment-methods~1cards/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1cards/post/responses/404/content/application~1json/example"},"paths/~1v2~1payment-methods~1cards/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1cards/post/responses/409/content/application~1json/example"},"paths/~1v2~1payment-methods~1cards/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1cards/post/responses/429/content/application~1json/example"},"paths/~1v2~1payment-methods~1cards/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1cards/post/responses/500/content/application~1json/example"},"paths/~1v2~1payment-methods~1ach/post/requestBody/content/application~1json/example":{"value":{"customerId":"3ad6a05a-48b4-4c77-9601-fdad2963b92b","name":"Business Checking","companyName":"Acme Corp Inc","routingNumber":"021000021","accountNumber":"1234567890","taxId":"12-3456789","accountHolderType":"Business","accountType":"Checking"},"id":"paths/~1v2~1payment-methods~1ach/post/requestBody/content/application~1json/example"},"paths/~1v2~1payment-methods~1ach/post/responses/200/content/application~1json/example":{"value":{"paymentMethodId":"83eed29d-849d-4aff-8ff7-02783bfe97d5"},"id":"paths/~1v2~1payment-methods~1ach/post/responses/200/content/application~1json/example"},"paths/~1v2~1payment-methods~1ach/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1ach/post/responses/400/content/application~1json/example"},"paths/~1v2~1payment-methods~1ach/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1ach/post/responses/401/content/application~1json/example"},"paths/~1v2~1payment-methods~1ach/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1ach/post/responses/403/content/application~1json/example"},"paths/~1v2~1payment-methods~1ach/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1ach/post/responses/404/content/application~1json/example"},"paths/~1v2~1payment-methods~1ach/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1ach/post/responses/409/content/application~1json/example"},"paths/~1v2~1payment-methods~1ach/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1ach/post/responses/429/content/application~1json/example"},"paths/~1v2~1payment-methods~1ach/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1ach/post/responses/500/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/200/content/application~1json/examples/Card payment method (customer-linked, default)":{"value":{"paymentMethodId":"6e22f0f3-f3ed-407c-a46f-ec9cffde5d5b","customerId":"588f57a5-fe6a-4844-851e-e98914e81980","name":"My Visa Card","type":"Card","isDefault":true,"createdOn":"2026-01-15T10:30:00.000Z","card":{"cardMask":"************1111","expirationMonth":12,"expirationYear":2033,"cardTokenType":"Local"},"ach":null},"key":"Card payment method (customer-linked, default)","summary":"Card payment method (customer-linked, default)","description":"Indicates a card payment method linked to a customer and marked as the customer's default.\n","id":"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/200/content/application~1json/examples/Card payment method (customer-linked, default)"},"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/200/content/application~1json/examples/ACH payment method (orphan, business)":{"value":{"paymentMethodId":"6bbfbe3e-04dd-41cd-82bf-1466e0159007","customerId":null,"name":"Acme Bus Savings","type":"ElectronicCheck","isDefault":false,"createdOn":"2026-02-01T09:00:000Z","card":null,"ach":{"accountNumber":"****6789","routingNumber":"021000021","accountType":"Checking","accountHolderType":"Business","taxId":"***-**-6789","companyName":"Acme Corp Inc"}},"key":"ACH payment method (orphan, business)","summary":"ACH payment method (orphan, business)","id":"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/200/content/application~1json/examples/ACH payment method (orphan, business)"},"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/400/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/401/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/403/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/404/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/429/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/get/responses/500/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/requestBody/content/application~1json/example":{"value":{"paymentName":"My Updated Card"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/requestBody/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/400/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/401/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/403/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/404/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/409/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/429/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/patch/responses/500/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/400/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/401/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/403/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/404/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/409/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/429/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}/delete/responses/500/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/400/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/401/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/402/content/application~1json/example":{"value":{"details":"The payment was declined by the processor.","statusCode":402,"source":"<Service>","exceptionType":"PaymentFailedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"P0000","title":"Payment failed","cause":"The payment was declined by the payment processor.","resolution":"Verify payment details, check available funds, or try a different payment method.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/402/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/403/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/404/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/409/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/429/content/application~1json/example"},"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-methods~1{paymentMethodId}~1set-default/post/responses/500/content/application~1json/example"},"paths/~1v2~1payment-sessions/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-sessions/post/responses/400/content/application~1json/example"},"paths/~1v2~1payment-sessions/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-sessions/post/responses/500/content/application~1json/example"},"paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses/404/content/application~1json/example"},"paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-sessions~1{paymentSessionId}/get/responses/500/content/application~1json/example"},"paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses/404/content/application~1json/example"},"paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1payment-sessions~1{paymentSessionId}~1cancel/post/responses/500/content/application~1json/example"},"paths/~1v2~1ping/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1ping/get/responses/400/content/application~1json/example"},"paths/~1v2~1ping/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1ping/get/responses/401/content/application~1json/example"},"paths/~1v2~1ping/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1ping/get/responses/403/content/application~1json/example"},"paths/~1v2~1ping/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1ping/get/responses/429/content/application~1json/example"},"paths/~1v2~1ping/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1ping/get/responses/500/content/application~1json/example"},"paths/~1v2~1pos~1transactions/get/responses/200/content/application~1json/example":{"value":{"items":[{"posTransactionId":"cdf3b72b-6bb5-4707-8963-1f73456323d8","createdOn":"2026-06-03T21:54:31.884Z","terminalId":"bcd3a843-9f21-4a71-a019-e1b336b65496","status":"Completed","transactionId":"1782bc6c-efb0-416d-8e62-627401707177","processedAmount":135.5,"currencyCode":"USD","targetTransactionId":null,"transactionType":"Sale"},{"posTransactionId":"18090b35-0758-4a5b-81ae-927d4496cd53","createdOn":"2026-06-03T21:59:31.884Z","terminalId":"bff9c356-fb17-4ed8-89ad-d980c92e391e","status":"TransactionProcessing","transactionId":null,"processedAmount":135.5,"currencyCode":"USD","targetTransactionId":null,"transactionType":"Authorization"}],"pageInfo":{"pageIndex":0,"pageSize":20,"totalItems":150,"totalPages":8,"hasMore":true}},"id":"paths/~1v2~1pos~1transactions/get/responses/200/content/application~1json/example"},"paths/~1v2~1pos~1transactions/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions/get/responses/400/content/application~1json/example"},"paths/~1v2~1pos~1transactions/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions/get/responses/401/content/application~1json/example"},"paths/~1v2~1pos~1transactions/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions/get/responses/403/content/application~1json/example"},"paths/~1v2~1pos~1transactions/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions/get/responses/429/content/application~1json/example"},"paths/~1v2~1pos~1transactions/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions/get/responses/500/content/application~1json/example"},"paths/~1v2~1pos~1transactions/post/requestBody/content/application~1json/example":{"value":{"posDeviceId":"POS-DEV-014","referenceId":"REF-POS-20260812-001","captureMethod":"Manual","baseAmount":42.75,"pricingType":"Cash","currencyCode":"USD","paymentProcessorId":"7b1e4a2c-9f3d-4e8b-b2a1-5c6d7e8f9a0b","customerId":"3c4d5e6f-7a8b-49c0-8d1e-2f3a4b5c6d7e","terminalId":"f4e3d2c1-b0a9-4f8e-9d7c-6b5a4938271f","waitForAcceptanceByTerminal":false,"readingMethod":"KeyedEntry","requestPaymentMethodStorageConsent":true,"extraAmounts":{"tipAmount":null,"tipRate":15}},"id":"paths/~1v2~1pos~1transactions/post/requestBody/content/application~1json/example"},"paths/~1v2~1pos~1transactions/post/responses/200/content/application~1json/example":{"value":{"posTransactionId":"6f2a8b3c-9d4e-4f1a-8b7c-3e5d6a9f0c1b","createdOn":"2026-08-12T09:15:22.100Z","modifiedOn":"2026-08-12T09:16:05.400Z","merchantId":"746ba4dd-b1b4-47c3-a034-72aa55007e86","customerId":"9f2b1c4d-7e3a-4f8b-90c1-2d3e4f5a6b7c","terminalId":"83a2baf4-2c5a-4326-acd9-65f26e47ac1e","paymentProcessorId":"2e8c8c3e-e034-42db-8169-1b7999a49cd0","posDeviceId":"POS-DEV-014","referenceId":"REF-POS-20260812-001","posTransactionStatus":"Completed","captureMethod":"Manual","transactionId":"cdb041da-90c6-4e03-82cf-3fa1178680ee","baseAmount":42.75,"currencyCode":"USD","extraAmounts":{"tipAmount":null,"tipRate":15},"processedAmount":49.16,"linkedTransaction":{"transactionId":"cdb041da-90c6-4e03-82cf-3fa1178680ee","transactionDateTime":"2026-08-12T09:16:04.900Z","transactionStatus":"Captured","transactionType":"Sale","cardTokenType":"Network","paymentMethodType":"Card","referenceId":"REF-POS-20260812-001","originalTransactionId":null,"processedAmount":49.16,"refundDetails":{"refundedAmount":0,"availableRefundAmount":49.16},"currencyCode":"USD","pricingType":"Card","paymentProcessorId":"2e8c8c3e-e034-42db-8169-1b7999a49cd0","customerId":"9f2b1c4d-7e3a-4f8b-90c1-2d3e4f5a6b7c","merchantId":"746ba4dd-b1b4-47c3-a034-72aa55007e86","batchId":null,"amountBreakdown":{"baseAmount":42.75,"tipAmount":null,"tipRate":15,"surchargeAmount":null,"surchargeRate":null,"discountAmount":null,"discountRate":null},"cardDetails":{"paymentMethodId":"39a95e35-6d50-45ec-884b-c2417edf005d","maskedCardNumber":"************1111","cardBrand":"Visa","cardType":"Credit","cardProcessedAsType":"Credit","cardDataSource":"EMV","cardholderVerificationMethod":"PIN","emvTags":{"ac":"9F2604A1B2C3D4E5F6","tvr":"0000008001","tsi":"6800","aid":"A0000000031010","applicationLabel":"VISA CREDIT","rawTags":null}},"achDetails":null,"processorDetails":{"mid":"932129304958123","tid":"6095275263","authCode":"VTLMC1","rrn":"59d5df1aa58d4de3969175eeece571c1"},"declineDetails":null,"addressVerificationServiceResponse":{"action":"Allow","responseCode":"Y","description":"Address and ZIP match"},"transactionEvents":[{"type":"Sale","status":"Approved","amount":49.16,"dateTime":"2026-08-12T09:16:04.900Z","originalTransactionId":null,"declineDetails":null}],"source":{"sourceType":"Terminal","sourceId":"83a2baf4-2c5a-4326-acd9-65f26e47ac1e","sourceName":"Front Counter Terminal 3"}}},"id":"paths/~1v2~1pos~1transactions/post/responses/200/content/application~1json/example"},"paths/~1v2~1pos~1transactions/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions/post/responses/400/content/application~1json/example"},"paths/~1v2~1pos~1transactions/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions/post/responses/401/content/application~1json/example"},"paths/~1v2~1pos~1transactions/post/responses/402/content/application~1json/example":{"value":{"details":"The payment was declined by the processor.","statusCode":402,"source":"<Service>","exceptionType":"PaymentFailedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"P0000","title":"Payment failed","cause":"The payment was declined by the payment processor.","resolution":"Verify payment details, check available funds, or try a different payment method.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions/post/responses/402/content/application~1json/example"},"paths/~1v2~1pos~1transactions/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions/post/responses/403/content/application~1json/example"},"paths/~1v2~1pos~1transactions/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions/post/responses/404/content/application~1json/example"},"paths/~1v2~1pos~1transactions/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions/post/responses/429/content/application~1json/example"},"paths/~1v2~1pos~1transactions/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions/post/responses/500/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/200/content/application~1json/example":{"value":{"posTransactionId":"51efbd85-3e2b-459c-87d0-34f4c046a21f","createdOn":"2026-06-03T21:59:31.891Z","merchantId":"746ba4dd-b1b4-47c3-a034-72aa55007e86","terminalId":"a84af02c-6de3-40ac-abda-0d8db96dec7b","paymentProcessorId":"451e4f53-9d81-48d8-a7c4-8167595adffa","posDeviceId":"POS-DEVICE-001","referenceId":"REF-12345","status":"Completed","transactionId":"7a62ba78-c4e2-4317-bc4e-c90a9d169107","processedAmount":135.5,"currencyCode":"USD","targetTransactionId":null,"transactionType":"Sale"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/200/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/400/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/401/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/402/content/application~1json/example":{"value":{"details":"The payment was declined by the processor.","statusCode":402,"source":"<Service>","exceptionType":"PaymentFailedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"P0000","title":"Payment failed","cause":"The payment was declined by the payment processor.","resolution":"Verify payment details, check available funds, or try a different payment method.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/402/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/403/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/404/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/429/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}/get/responses/500/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/200/content/application~1json/example":{"value":{"posTransactionId":"2eca4f2c-0cc2-4355-aa0b-a3e65368591d","status":"TransactionProcessing"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/200/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/400/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/401/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/402/content/application~1json/example":{"value":{"details":"The payment was declined by the processor.","statusCode":402,"source":"<Service>","exceptionType":"PaymentFailedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"P0000","title":"Payment failed","cause":"The payment was declined by the payment processor.","resolution":"Verify payment details, check available funds, or try a different payment method.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/402/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/403/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/404/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/409/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/429/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1cancel/post/responses/500/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/requestBody/content/application~1json/example":{"value":{"terminalId":"5ddd62a7-bb28-41b1-bc50-179e98dce577"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/requestBody/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/400/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/401/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/403/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/404/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/409/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/429/content/application~1json/example"},"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1pos~1transactions~1{posTransactionId}~1print-receipt/post/responses/500/content/application~1json/example"},"paths/~1v2~1settings~1payment-config/get/responses/200/content/application~1json/example":{"value":{"zeroCostProcessingOption":"None","defaultTipsOptions":[10,15,20],"defaultSurchargeRate":1.5,"defaultCashDiscountRate":2,"defaultDualPricingRate":1.8,"availableCurrencies":["USD"],"availableCardTypes":["Visa","MasterCard","AmericanExpress","Discover"],"availableTransactionTypes":["Sale","Capture","Refund","Void"],"isTipsEnabled":true,"availablePaymentProcessors":[{"paymentProcessorId":"ecd7c87b-7165-4a67-a067-24c9c9e1bbf4","processorName":"TSYS","isDefault":true,"type":"Tsys","settlementBatchTimeSlots":[{"hours":2,"minutes":10,"timezoneName":"America/New_York"}]}],"addressVerificationServiceOptions":{"isEnabled":true,"profile":"Strict"},"isCustomerCardSavingByTerminalEnabled":true,"companyName":"Test Company","mccCode":"5411","mccCodeDescription":"Grocery Stores, Supermarkets","currency":"USD","maxTransactionAmount":10000,"ttpIosTerminalProfileId":"ios-terminal-profile-id"},"id":"paths/~1v2~1settings~1payment-config/get/responses/200/content/application~1json/example"},"paths/~1v2~1settings~1payment-config/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1payment-config/get/responses/400/content/application~1json/example"},"paths/~1v2~1settings~1payment-config/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1payment-config/get/responses/401/content/application~1json/example"},"paths/~1v2~1settings~1payment-config/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1payment-config/get/responses/403/content/application~1json/example"},"paths/~1v2~1settings~1payment-config/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1payment-config/get/responses/429/content/application~1json/example"},"paths/~1v2~1settings~1payment-config/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1payment-config/get/responses/500/content/application~1json/example"},"paths/~1v2~1settings~1contact-information/get/responses/200/content/application~1json/example":{"value":{"contactInfos":[{"contactInfoId":"8d638f27-1a16-4f1b-92fe-0ea16d4a6461","addressName":"Main Office","email":"contact@company.com","mobilePhoneNumber":"+12125550100","isMainAddress":true,"isDefaultAddress":true,"city":"New York","countryCode":"US","addressLine1":"123 Main St","addressLine2":"Suite 100","postalCode":"10001","stateCode":"NY"}]},"id":"paths/~1v2~1settings~1contact-information/get/responses/200/content/application~1json/example"},"paths/~1v2~1settings~1contact-information/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1contact-information/get/responses/400/content/application~1json/example"},"paths/~1v2~1settings~1contact-information/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1contact-information/get/responses/401/content/application~1json/example"},"paths/~1v2~1settings~1contact-information/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1contact-information/get/responses/403/content/application~1json/example"},"paths/~1v2~1settings~1contact-information/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1contact-information/get/responses/429/content/application~1json/example"},"paths/~1v2~1settings~1contact-information/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1contact-information/get/responses/500/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/get/responses/200/content/application~1json/example":{"value":{"level2Settings":{"taxRate":8.5},"level3Settings":{"product":{"productName":"Office Supplies","code":"OFF001","unitPrice":25,"measurementUnit":"pcs","quantity":10,"discountPercentage":5,"description":"Standard office supplies"},"shippingChargeRate":5,"dutyChargeRate":2.5}},"id":"paths/~1v2~1settings~1transaction-autofill/get/responses/200/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1transaction-autofill/get/responses/400/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1transaction-autofill/get/responses/401/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1transaction-autofill/get/responses/403/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1transaction-autofill/get/responses/429/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1transaction-autofill/get/responses/500/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/patch/requestBody/content/application~1json/example":{"value":{"level2Settings":{"taxRate":8.5},"level3Settings":{"product":{"productName":"Office Supplies","code":"OFF001","unitPrice":25,"measurementUnit":"pcs","quantity":10,"discountPercentage":5,"description":"Standard office supplies"},"shippingChargeRate":5,"dutyChargeRate":2.5}},"id":"paths/~1v2~1settings~1transaction-autofill/patch/requestBody/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/patch/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1transaction-autofill/patch/responses/400/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/patch/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1transaction-autofill/patch/responses/401/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/patch/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1transaction-autofill/patch/responses/403/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/patch/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1transaction-autofill/patch/responses/404/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/patch/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1transaction-autofill/patch/responses/409/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/patch/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1transaction-autofill/patch/responses/429/content/application~1json/example"},"paths/~1v2~1settings~1transaction-autofill/patch/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settings~1transaction-autofill/patch/responses/500/content/application~1json/example"},"paths/~1v2~1settlements~1batches/get/responses/200/content/application~1json/example":{"value":{"items":[{"batchId":"21c75430-a316-456f-9126-365760dca33a","paymentProcessorId":"1092a854-1708-4e0c-8d86-1b8fe34b37ec","paymentProcessorName":"TSYS","externalBatchId":"BATCH-001","batchDateTime":"2026-03-23T12:00:56.264Z","transactionCount":15,"netAmount":1250,"salesAmount":1300,"refundsAmount":50,"status":"Settled"}],"pageInfo":{"pageIndex":0,"pageSize":20,"totalItems":150,"totalPages":8,"hasMore":true}},"id":"paths/~1v2~1settlements~1batches/get/responses/200/content/application~1json/example"},"paths/~1v2~1settlements~1batches/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1batches/get/responses/400/content/application~1json/example"},"paths/~1v2~1settlements~1batches/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1batches/get/responses/401/content/application~1json/example"},"paths/~1v2~1settlements~1batches/get/responses/403/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1batches/get/responses/403/content/application~1json/example"},"paths/~1v2~1settlements~1batches/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1batches/get/responses/429/content/application~1json/example"},"paths/~1v2~1settlements~1batches/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1batches/get/responses/500/content/application~1json/example"},"paths/~1v2~1settlements~1settle/post/requestBody/content/application~1json/example":{"value":{"paymentProcessorId":"70f07e54-ad9d-417c-9ab4-d4acc5302aa8"},"id":"paths/~1v2~1settlements~1settle/post/requestBody/content/application~1json/example"},"paths/~1v2~1settlements~1settle/post/responses/200/content/application~1json/example":{"value":{"status":"Approve","message":"Batch closed successfully","processorResponseCode":"00"},"id":"paths/~1v2~1settlements~1settle/post/responses/200/content/application~1json/example"},"paths/~1v2~1settlements~1settle/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1settle/post/responses/400/content/application~1json/example"},"paths/~1v2~1settlements~1settle/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1settle/post/responses/401/content/application~1json/example"},"paths/~1v2~1settlements~1settle/post/responses/402/content/application~1json/example":{"value":{"details":"The payment was declined by the processor.","statusCode":402,"source":"<Service>","exceptionType":"PaymentFailedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"P0000","title":"Payment failed","cause":"The payment was declined by the payment processor.","resolution":"Verify payment details, check available funds, or try a different payment method.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1settle/post/responses/402/content/application~1json/example"},"paths/~1v2~1settlements~1settle/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1settle/post/responses/403/content/application~1json/example"},"paths/~1v2~1settlements~1settle/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1settle/post/responses/404/content/application~1json/example"},"paths/~1v2~1settlements~1settle/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1settle/post/responses/409/content/application~1json/example"},"paths/~1v2~1settlements~1settle/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1settle/post/responses/429/content/application~1json/example"},"paths/~1v2~1settlements~1settle/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1settlements~1settle/post/responses/500/content/application~1json/example"},"paths/~1v2~1terminals/get/responses/200/content/application~1json/example":{"value":{"items":[{"terminalId":"0b61c6b6-e633-4c3d-91ae-9810ff42ccdc","merchantId":"fffcecc3-2e15-4e93-8144-5353785cec3b","merchantCompanyName":"Peppared Street Cafe","serialNumber":"SN100001","terminalManufacturer":"Sunmi","terminalModel":"SunmiP2","terminalMode":"SemiIntegrated","terminalStatus":"Ready","connectionStatus":"Online","lastSeenOn":"2026-08-11T18:44:45.638Z"}],"pageInfo":{"pageIndex":0,"pageSize":20,"totalItems":3,"totalPages":1,"hasMore":false}},"id":"paths/~1v2~1terminals/get/responses/200/content/application~1json/example"},"paths/~1v2~1terminals/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1terminals/get/responses/400/content/application~1json/example"},"paths/~1v2~1terminals/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1terminals/get/responses/401/content/application~1json/example"},"paths/~1v2~1terminals/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1terminals/get/responses/403/content/application~1json/example"},"paths/~1v2~1terminals/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1terminals/get/responses/429/content/application~1json/example"},"paths/~1v2~1terminals/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1terminals/get/responses/500/content/application~1json/example"},"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/200/content/application~1json/example":{"value":{"terminalId":"03a88aa0-14ef-4334-8b7a-13356fec8202","merchantId":"fffcecc3-2e15-4e93-8144-5353785cec3b","terminalStatus":"Ready","lastSeenOn":"2026-08-11T18:44:45.6451072Z","debitPinKey":"Injected","terminalAppVersion":"1.0.0","connectionStatus":"Online","connectionType":"WiFi","wifiConnectionStrength":85,"mobileConnectionStrength":0,"batteryLevel":90,"printerStatus":"Normal"},"id":"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/200/content/application~1json/example"},"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/400/content/application~1json/example"},"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/401/content/application~1json/example"},"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/403/content/application~1json/example"},"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/404/content/application~1json/example"},"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/429/content/application~1json/example"},"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1terminals~1{terminalId}~1status/get/responses/500/content/application~1json/example"},"paths/~1v2~1transactions/get/responses/200/content/application~1json/example":{"value":{"items":[{"transactionId":"3a2257af-e059-4718-b1c6-ee60bd83816e","transactionDateTime":"2025-06-15T14:30:56.264Z","status":"Captured","paymentMethodType":"Card","referenceId":"REF-001","processedAmount":115.5,"currencyCode":"USD","amountBreakdown":{"baseAmount":99.99,"tipAmount":10,"tipRate":0,"surchargeAmount":5.5,"discountAmount":0,"discountARate":0},"addressVerificationServiceResponse":{"action":"Allow","responseCode":"Y","description":"Address and ZIP code match"},"cardDetails":{"maskedCardNumber":"411111******1111","cardType":"Visa","creditDebitType":"Credit"},"achDetails":null,"transactionEvents":[{"type":"Sale","status":"Approved","amount":115.5,"dateTime":"2025-06-15T14:30:56.264Z","processorResponse":{"processorName":"TSYS","responseCode":"00","responseMessage":"APPROVAL","responseDefinition":"Approved"}}]},{"transactionId":"53c558a4-b01a-4a43-a8c1-1c9820250958","transactionDateTime":"2025-06-15T10:00:56.264Z","status":"Captured","paymentMethodType":"ACH","referenceId":"REF-002","processedAmount":200,"currencyCode":"USD","amountBreakdown":{"baseAmount":200,"tipAmount":0,"tipRate":5.5,"surchargeAmount":0,"discountAmount":0,"discountRate":0},"addressVerificationServiceResponse":null,"cardDetails":null,"achDetails":{"maskedAccountNumber":"****6789","maskedRoutingNumber":"****0001","accountHolderType":"Personal","accountType":"Checking","secCode":"Web"},"transactionEvents":[{"type":"Sale","status":"Approved","amount":200,"dateTime":"2025-06-15T10:00:000Z","processorResponse":{"processorName":"ACH","responseCode":"1","responseMessage":"Approved","responseDefinition":null}}]}],"pageInfo":{"pageIndex":0,"pageSize":20,"totalItems":150,"totalPages":8,"hasMore":true}},"id":"paths/~1v2~1transactions/get/responses/200/content/application~1json/example"},"paths/~1v2~1transactions/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/get/responses/400/content/application~1json/example"},"paths/~1v2~1transactions/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/get/responses/401/content/application~1json/example"},"paths/~1v2~1transactions/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/get/responses/403/content/application~1json/example"},"paths/~1v2~1transactions/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/get/responses/429/content/application~1json/example"},"paths/~1v2~1transactions/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/get/responses/500/content/application~1json/example"},"paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — saved payment method":{"value":{"paymentProcessorId":"a2f2c2e7-0b23-4682-8f99-ab7707205461","baseAmount":100,"currencyCode":"USD","referenceId":"REF-CARD-SAVED-001","isCustomerInitiatedTransaction":true,"pricingType":"Card","extraAmounts":null,"transactionEnhancedData":null,"billingAddress":null,"shippingAddress":null,"contactInfo":null,"transactionDetails":{"cardData":{"captureMethod":"Auto","paymentMethodId":"e397e367-bc4a-4b69-bd78-32e3e12327c2","paymentMethodDetails":null},"achData":null},"deviceId":null,"platform":null,"appVersion":null,"sdkVersion":null},"key":"Card — saved payment method","summary":"Card — saved payment method","id":"paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — saved payment method"},"paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — new card":{"value":{"paymentProcessorId":"a2f2c2e7-0b23-4682-8f99-ab7707205461","baseAmount":100,"currencyCode":"USD","referenceId":"REF-CARD-NEW-001","isCustomerInitiatedTransaction":true,"pricingType":"Card","extraAmounts":null,"transactionEnhancedData":null,"billingAddress":{"city":"New York","countryCode":"US","addressLine1":"123 Main Street","addressLine2":"Suite 100","postalCode":"10001","stateCode":"NY"},"shippingAddress":null,"contactInfo":{"firstName":"John","lastName":"Doe","companyName":null,"email":"john.doe@example.com","mobilePhoneNumber":"+14125553845","hasSmsConsent":true},"transactionDetails":{"cardData":{"captureMethod":"Auto","paymentMethodId":null,"paymentMethodDetails":{"cardNumber":"4111111111111111","securityCode":"123","expirationMonth":12,"expirationYear":2030}},"achData":null},"deviceId":null,"platform":null,"appVersion":null,"sdkVersion":null},"key":"Card — new card","summary":"Card — new card","id":"paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/Card — new card"},"paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — saved payment method":{"value":{"paymentProcessorId":"8932c37e-9ae0-46ed-8da4-e70eb9458596","baseAmount":100,"currencyCode":"USD","referenceId":"REF-ACH-SAVED-001","isCustomerInitiatedTransaction":true,"pricingType":null,"extraAmounts":null,"transactionEnhancedData":null,"billingAddress":null,"shippingAddress":null,"contactInfo":null,"transactionDetails":{"cardData":null,"achData":{"paymentMethodId":"bc665a1b-4231-4e52-bc43-dc04623165ec","paymentMethodDetails":null,"secCode":"Web","isSameDayProcessing":false,"requesterIpAddress":"203.0.113.45"}},"deviceId":null,"platform":null,"appVersion":null,"sdkVersion":null},"key":"ACH — saved payment method","summary":"ACH — saved payment method","id":"paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — saved payment method"},"paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — new account":{"value":{"paymentProcessorId":"8932c37e-9ae0-46ed-8da4-e70eb9458596","baseAmount":100,"currencyCode":"USD","referenceId":"REF-ACH-NEW-001","isCustomerInitiatedTransaction":true,"pricingType":null,"extraAmounts":null,"transactionEnhancedData":null,"billingAddress":{"city":"New York","countryCode":"US","addressLine1":"123 Main Street","addressLine2":"Suite 100","postalCode":"10001","stateCode":"NY"},"shippingAddress":null,"contactInfo":{"firstName":"John","lastName":"Doe","companyName":"Acme Inc","email":"john.doe@example.com","mobilePhoneNumber":"+14125553845","hasSmsConsent":false},"transactionDetails":{"cardData":null,"achData":{"paymentMethodId":null,"paymentMethodDetails":{"routingNumber":"021000021","accountNumber":"1234567890","taxId":"12-3456789","accountHolderType":"Personal","accountType":"Checking"},"secCode":"PPD","isSameDayProcessing":false,"requesterIpAddress":"203.0.113.45"}},"deviceId":null,"platform":null,"appVersion":null,"sdkVersion":null},"key":"ACH — new account","summary":"ACH — new account","id":"paths/~1v2~1transactions/post/requestBody/content/application~1json/examples/ACH — new account"},"paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (Authorization)":{"value":{"transactionId":"90d084d6-55b8-4fb8-b658-861534d07f9a","transactionStatus":"Pending","processedAmount":100,"currencyCode":"USD","amountDetails":{"baseAmount":100,"tipAmount":0,"tipRate":0,"surchargeAmount":0,"discountAmount":0,"discountRate":0},"processorResponse":{"processorName":"TSYS","responseCode":"00","responseMessage":"Approved","responseDefinition":"Approved and completed"},"responseDetails":null,"addressVerificationServiceResponse":{"action":"Allow","responseCode":"Y","description":"Address and ZIP match"},"receipt":null},"key":"Create transaction response (Authorization)","summary":"Create transaction response (Authorization)","id":"paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (Authorization)"},"paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (Sale)":{"value":{"transactionId":"5f6f782f-37af-44e1-bb18-2bc35e411899","transactionStatus":"Approved","processedAmount":115.5,"currencyCode":"USD","amountDetails":{"baseAmount":100,"tipAmount":15,"tipRate":0,"surchargeAmount":3,"discountAmount":2.5,"discountRate":0},"processorResponse":{"processorName":"TSYS","responseCode":"00","responseMessage":"Approved","responseDefinition":"Approved and completed"},"responseDetails":null,"addressVerificationServiceResponse":{"action":"Allow","responseCode":"Y","description":"Address and ZIP match"},"receipt":null},"key":"Create transaction response (Sale)","summary":"Create transaction response (Sale)","id":"paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (Sale)"},"paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (ACH)":{"value":{"transactionId":"c5b0299f-e9f6-498b-90c7-688bffec2e6e","transactionStatus":"Approved","processedAmount":100,"currencyCode":"USD","amountDetails":{"baseAmount":100,"tipAmount":0,"tipRate":0,"surchargeAmount":0,"discountAmount":0,"discountRate":0},"processorResponse":{"processorName":"ACH","responseCode":"1","responseMessage":"Approved","responseDefinition":"Transaction approved"},"responseDetails":null,"addressVerificationServiceResponse":null,"receipt":null},"key":"Create transaction response (ACH)","summary":"Create transaction response (ACH)","description":"Response after approved ACH debit transaction. No AVS (address verification service).","id":"paths/~1v2~1transactions/post/responses/200/content/application~1json/examples/Create transaction response (ACH)"},"paths/~1v2~1transactions/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/post/responses/400/content/application~1json/example"},"paths/~1v2~1transactions/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/post/responses/401/content/application~1json/example"},"paths/~1v2~1transactions/post/responses/402/content/application~1json/example":{"value":{"details":"The payment was declined by the processor.","statusCode":402,"source":"<Service>","exceptionType":"PaymentFailedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"P0000","title":"Payment failed","cause":"The payment was declined by the payment processor.","resolution":"Verify payment details, check available funds, or try a different payment method.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/post/responses/402/content/application~1json/example"},"paths/~1v2~1transactions/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/post/responses/403/content/application~1json/example"},"paths/~1v2~1transactions/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/post/responses/404/content/application~1json/example"},"paths/~1v2~1transactions/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/post/responses/409/content/application~1json/example"},"paths/~1v2~1transactions/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/post/responses/429/content/application~1json/example"},"paths/~1v2~1transactions/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions/post/responses/500/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}/get/responses/200/content/application~1json/examples/Card transaction (Completed)":{"value":{"transactionId":"f184155d-5737-440c-abd4-1b58f0b9119c","transactionDateTime":"2025-06-15T14:30:56.264Z","status":"Captured","paymentMethodType":"Card","referenceId":"REF-001","processedAmount":115.5,"currencyCode":"USD","amountBreakdown":{"baseAmount":100,"tipAmount":10,"surchargeAmount":5.5,"discountAmount":0},"addressVerificationServiceResponse":{"action":"Allow","responseCode":"Y","description":"Address and postal code match"},"cardDetails":{"maskedCardNumber":"411111******1111","cardType":"Visa","creditDebitType":"Credit"},"achDetails":null,"transactionEvents":[{"type":"Sale","status":"Approved","amount":115.5,"dateTime":"2025-06-15T14:30:56.264Z","processorResponse":{"processorName":"TSYS","responseCode":"00","responseMessage":"APPROVAL","responseDefinition":"Approved"}}]},"key":"Card transaction (Completed)","summary":"Card transaction (Completed)","description":"A completed card sale transaction with AVS (address verification service) response and amount breakdown.\n","id":"paths/~1v2~1transactions~1{transactionId}/get/responses/200/content/application~1json/examples/Card transaction (Completed)"},"paths/~1v2~1transactions~1{transactionId}/get/responses/200/content/application~1json/examples/ACH transaction (Completed)":{"value":{"transactionId":"77838fb3-9701-4f37-8c17-6fa5ab6e2dc1","transactionDateTime":"2025-06-15T10:00:56.264Z","status":"Captured","paymentMethodType":"ACH","referenceId":"REF-002","processedAmount":200,"currencyCode":"USD","amountBreakdown":{"baseAmount":200,"tipAmount":0,"tipRate":0,"surchargeAmount":0,"discountAmount":0,"discountRate":0},"addressVerificationServiceResponse":null,"cardDetails":null,"achDetails":{"maskedAccountNumber":"****6789","maskedRoutingNumber":"****0001","accountHolderType":"Personal","accountType":"Checking","secCode":"Web"},"transactionEvents":[{"type":"Sale","status":"Approved","amount":200,"dateTime":"2025-06-15T10:00:56.264Z","processorResponse":{"processorName":"ACH","responseCode":"1","responseMessage":"Approved","responseDefinition":null}}]},"key":"ACH transaction (Completed)","summary":"ACH transaction (Completed)","description":"A completed ACH debit transaction. No AVS (address verification service) response.\n","id":"paths/~1v2~1transactions~1{transactionId}/get/responses/200/content/application~1json/examples/ACH transaction (Completed)"},"paths/~1v2~1transactions~1{transactionId}/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}/get/responses/400/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}/get/responses/401/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}/get/responses/403/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}/get/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}/get/responses/404/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}/get/responses/429/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}/get/responses/500/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1capture/post/requestBody/content/application~1json/example":{"value":{"amount":50},"id":"paths/~1v2~1transactions~1{transactionId}~1capture/post/requestBody/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/200/content/application~1json/example":{"value":{"transactionId":"1db9c80e-1265-49b9-b2ef-fbf92acf5d42","transactionStatus":"Approved","processedAmount":100,"currencyCode":"USD","amountDetails":{"baseAmount":100,"tipAmount":0,"surchargeAmount":0,"discountAmount":0},"processorResponse":{"processorName":"TSYS","responseCode":"00","responseMessage":"Approved","responseDefinition":"Approved and completed"},"responseDetails":null,"addressVerificationServiceResponse":null,"receipt":null},"id":"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/200/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/400/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/401/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/402/content/application~1json/example":{"value":{"details":"The payment was declined by the processor.","statusCode":402,"source":"<Service>","exceptionType":"PaymentFailedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"P0000","title":"Payment failed","cause":"The payment was declined by the payment processor.","resolution":"Verify payment details, check available funds, or try a different payment method.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/402/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/403/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/404/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/409/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/429/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1capture/post/responses/500/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1reversal/post/requestBody/content/application~1json/example":{"value":{"amount":25},"id":"paths/~1v2~1transactions~1{transactionId}~1reversal/post/requestBody/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/200/content/application~1json/example":{"value":{"transactionId":"e54f0127-fee5-47a2-8e06-b73fcf69fbe2","transactionStatus":"Approved","processedAmount":25,"currencyCode":"USD","processorResponse":{"processorName":"TSYS","responseCode":"00","responseMessage":"Approved","responseDefinition":"Approved and completed"}},"id":"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/200/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/400/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/401/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/402/content/application~1json/example":{"value":{"details":"The payment was declined by the processor.","statusCode":402,"source":"<Service>","exceptionType":"PaymentFailedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"P0000","title":"Payment failed","cause":"The payment was declined by the payment processor.","resolution":"Verify payment details, check available funds, or try a different payment method.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/402/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/403/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/404/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/409/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/429/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1reversal/post/responses/500/content/application~1json/example"},"paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/Card unreferenced refund":{"value":{"paymentProcessorId":"7538ed96-b5ec-488e-94a0-b44ef5e77833","baseAmount":100,"currencyCode":"USD","referenceId":"ext-ref-123","billingAddress":{"city":"New York","countryCode":"US","addressLine1":"123 Main Street","addressLine2":"Suite 100","postalCode":"10001","stateCode":"NY"},"shippingAddress":{"city":"New York","countryCode":"US","addressLine1":"456 Delivery Ave","addressLine2":"Floor 2","postalCode":"10002","stateCode":"NY"},"contactInfo":{"firstName":"John","lastName":"Doe","companyName":"Acme Inc","email":"john.doe@example.com","mobilePhoneNumber":"+14125553845","hasSmsConsent":false},"creditDetails":{"cardData":{"paymentMethodDetails":{"cardNumber":"4111111111111111","securityCode":"123","expirationMonth":12,"expirationYear":2033}},"achData":null}},"key":"Card unreferenced refund","summary":"Card unreferenced refund","description":"Unreferenced card refund using raw card data.\nSaved payment methods are not supported for unreferenced credits.\n","id":"paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/Card unreferenced refund"},"paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/ACH credit":{"value":{"paymentProcessorId":"e77570bc-981c-4ffd-ac8c-a33e950016b2","baseAmount":100,"currencyCode":"USD","referenceId":"ext-ref-123","billingAddress":{"city":"New York","countryCode":"US","addressLine1":"123 Main Street","addressLine2":"Suite 100","postalCode":"10001","stateCode":"NY"},"shippingAddress":{"city":"New York","countryCode":"US","addressLine1":"456 Delivery Ave","addressLine2":"Floor 2","postalCode":"10002","stateCode":"NY"},"contactInfo":{"firstName":"John","lastName":"Doe","companyName":"Acme Inc","email":"john.doe@example.com","mobilePhoneNumber":"+14125553845","hasSmsConsent":false},"creditDetails":{"cardData":null,"achData":{"paymentMethodId":null,"paymentMethodDetails":{"routingNumber":"021000021","accountNumber":"1234567890","taxId":"12-3456789","accountHolderType":"Personal","accountType":"Checking"},"secCode":"PPD","isSameDayProcessing":false,"requesterIpAddress":"203.0.113.45"}}},"key":"ACH credit","summary":"ACH credit","description":"ACH credit using new bank-account details (routing/account supplied directly in the request).\n","id":"paths/~1v2~1transactions~1credit/post/requestBody/content/application~1json/examples/ACH credit"},"paths/~1v2~1transactions~1credit/post/responses/200/content/application~1json/example":{"value":{"transactionId":"ca1a4988-7541-4be1-83d5-4111a50b16a3","transactionStatus":"Approved","processedAmount":100,"currencyCode":"USD","processorResponse":{"processorName":"TSYS","responseCode":"00","responseMessage":"Approved","responseDefinition":"Approved and completed"}},"id":"paths/~1v2~1transactions~1credit/post/responses/200/content/application~1json/example"},"paths/~1v2~1transactions~1credit/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1credit/post/responses/400/content/application~1json/example"},"paths/~1v2~1transactions~1credit/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1credit/post/responses/401/content/application~1json/example"},"paths/~1v2~1transactions~1credit/post/responses/402/content/application~1json/example":{"value":{"details":"The payment was declined by the processor.","statusCode":402,"source":"<Service>","exceptionType":"PaymentFailedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"P0000","title":"Payment failed","cause":"The payment was declined by the payment processor.","resolution":"Verify payment details, check available funds, or try a different payment method.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1credit/post/responses/402/content/application~1json/example"},"paths/~1v2~1transactions~1credit/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1credit/post/responses/403/content/application~1json/example"},"paths/~1v2~1transactions~1credit/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1credit/post/responses/404/content/application~1json/example"},"paths/~1v2~1transactions~1credit/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1credit/post/responses/409/content/application~1json/example"},"paths/~1v2~1transactions~1credit/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1credit/post/responses/429/content/application~1json/example"},"paths/~1v2~1transactions~1credit/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1credit/post/responses/500/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/requestBody/content/application~1json/example":{"value":{"tipAmount":22.75,"tipRate":0},"id":"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/requestBody/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/200/content/application~1json/example":{"value":{"transactionId":"066706fe-d3c7-4a7c-8671-8ff3cc9e94ec","transactionStatus":"Approved","processedAmount":105,"currencyCode":"USD","amountDetails":{"baseAmount":100,"tipAmount":5,"surchargeAmount":0,"discountAmount":0},"processorResponse":{"processorName":"TSYS","responseCode":"00","responseMessage":"Approved","responseDefinition":"Approved and completed"},"responseDetails":null,"addressVerificationServiceResponse":null,"receipt":null},"id":"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/200/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/400/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/401/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/402/content/application~1json/example":{"value":{"details":"The payment was declined by the processor.","statusCode":402,"source":"<Service>","exceptionType":"PaymentFailedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"P0000","title":"Payment failed","cause":"The payment was declined by the payment processor.","resolution":"Verify payment details, check available funds, or try a different payment method.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/402/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/403/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/404/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/409/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/429/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1tip-adjustment/post/responses/500/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/200/content/application~1json/example":{"value":{"transactionId":"4b22b7a3-b536-4247-975e-b8c428fc48e6","type":"Hold","transactionStatus":"Approved","processorResponse":{"processorName":"ACH","responseCode":"00","responseMessage":"Approved","responseDefinition":"Transaction hold applied successfully"}},"id":"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/200/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/400/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/401/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/402/content/application~1json/example":{"value":{"details":"The payment was declined by the processor.","statusCode":402,"source":"<Service>","exceptionType":"PaymentFailedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"P0000","title":"Payment failed","cause":"The payment was declined by the payment processor.","resolution":"Verify payment details, check available funds, or try a different payment method.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/402/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/403/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/404/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/409/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/429/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1hold/post/responses/500/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/200/content/application~1json/example":{"value":{"transactionId":"db2d3d8b-bd69-44a8-8960-e932fbe61365","type":"UnHold","transactionStatus":"Approved","processorResponse":{"processorName":"ACH","responseCode":"00","responseMessage":"Approved","responseDefinition":"Transaction hold released successfully"}},"id":"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/200/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/400/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/401/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/402/content/application~1json/example":{"value":{"details":"The payment was declined by the processor.","statusCode":402,"source":"<Service>","exceptionType":"PaymentFailedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"P0000","title":"Payment failed","cause":"The payment was declined by the payment processor.","resolution":"Verify payment details, check available funds, or try a different payment method.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/402/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/403/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/404/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/409/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/429/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1release-hold/post/responses/500/content/application~1json/example"},"paths/~1v2~1transactions~1calculate-amount/post/requestBody/content/application~1json/example":{"value":{"baseAmount":100,"currencyCode":"USD","pricingType":"Card","discountAmount":0,"discountRate":5,"surchargeRate":2.5,"tipAmount":15,"tipRate":0},"id":"paths/~1v2~1transactions~1calculate-amount/post/requestBody/content/application~1json/example"},"paths/~1v2~1transactions~1calculate-amount/post/responses/200/content/application~1json/example":{"value":{"currencyCode":"USD","zeroCostProcessingOption":"Surcharge","pricingType":"Card","cash":{"baseAmount":100,"discountAmount":15,"discountRate":0,"surchargeAmount":0,"surchargeRate":0,"tipAmount":15,"tipRate":0,"totalAmount":110},"creditCard":{"baseAmount":100,"discountAmount":15,"discountRate":0,"surchargeAmount":3.5,"surchargeRate":0,"tipAmount":15,"tipRate":0,"totalAmount":113.5},"debitCard":{"baseAmount":100,"discountAmount":5,"discountRate":0,"surchargeAmount":0,"surchargeRate":0,"tipAmount":15,"tipRate":0,"totalAmount":110},"ach":{"baseAmount":100,"discountAmount":5,"discountRate":0,"surchargeAmount":0,"surchargeRate":0,"tipAmount":15,"tipRate":0,"totalAmount":110}},"id":"paths/~1v2~1transactions~1calculate-amount/post/responses/200/content/application~1json/example"},"paths/~1v2~1transactions~1calculate-amount/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1calculate-amount/post/responses/400/content/application~1json/example"},"paths/~1v2~1transactions~1calculate-amount/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1calculate-amount/post/responses/401/content/application~1json/example"},"paths/~1v2~1transactions~1calculate-amount/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1calculate-amount/post/responses/403/content/application~1json/example"},"paths/~1v2~1transactions~1calculate-amount/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1calculate-amount/post/responses/429/content/application~1json/example"},"paths/~1v2~1transactions~1calculate-amount/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1calculate-amount/post/responses/500/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/requestBody/content/application~1json/example":{"value":{"mobilePhoneNumber":"+15551234567","hasCustomerConsent":true},"id":"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/requestBody/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/400/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/401/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/403/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/404/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/409/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/429/content/application~1json/example"},"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1transactions~1{transactionId}~1share-receipt/post/responses/500/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints/get/responses/400/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints/get/responses/401/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints/get/responses/403/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints/get/responses/429/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints/get/responses/500/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/post/responses/200/content/application~1json/example":{"value":{"endpointId":"1e3fd30d-5fc2-4a69-9ea6-d0dcf05ab5ce","endpointName":"Peppared Street Cafe's Reconciliation","endpointUrl":"https://example.com/webhooks/pepparedstreetcafe","endpointStatus":"Active","hmacSecret":"7b3e9a1f4c8d2056e1a9b7c3f5d80426a9c1e3b5d7f9024680ace13579bdf024","eventTypes":["transaction.card.captured","transaction.card.refunded","settlement.batch.completed"],"createdOn":"2026-05-05T14:30:00Z"},"id":"paths/~1v2~1webhooks~1endpoints/post/responses/200/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints/post/responses/400/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints/post/responses/401/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints/post/responses/403/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints/post/responses/404/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints/post/responses/409/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints/post/responses/429/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints/post/responses/500/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/400/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/404/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/get/responses/500/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/requestBody/content/application~1json/example":{"value":{"endpointName":"Peppared Street Cafe's Reconciliation","endpointUrl":"https://example.com/webhooks/pepparedstreetcafe","endpointStatus":"Active","eventTypes":["transaction.card.captured","transaction.card.refunded","settlement.batch.completed"]},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/requestBody/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/400/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/404/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/patch/responses/500/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/400/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/401/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/403/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/409/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/429/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}/delete/responses/500/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/200/content/application~1json/example":{"value":{"isDelivered":true,"endpointHTTPResponseCode":200,"roundTripDurationMs":142,"errorMessage":null},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/200/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/400/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/401/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/403/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/404/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/409/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/429/content/application~1json/example"},"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1endpoints~1{endpointId}~1ping/post/responses/500/content/application~1json/example"},"paths/~1v2~1webhooks~1event-types/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1event-types/get/responses/500/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs/get/responses/400/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs/get/responses/500/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/200/content/application~1json/example":{"value":{"requestHeaders":{"Content-Type":"application/json","X-Flute-Signature":"t=1746450622,v1=5257a869e7ecebeda32affa6c66e8fb5e5e64a50b9b3e8bbf9c1a8d8f5e9d0a1","X-Flute-Event-Id":"0e991cfc-28cf-4558-8874-bf2bbee8a406","X-Flute-Event-Type":"settlement.batch.completed"},"requestBody":"{\"id\":\"8b7f1c87-c1da-48f7-82d1-426ae0960c53\",\"type\":\"settlement.batch.completed\",\"createdAt\":\"2026-05-05T13:10:00Z\",\"data\":{\"batchId\":\"617f9259-8900-4134-b035-c53dd5d9675e\",\"settledAmount\":12500.00}}","responseHeaders":{"Content-Type":"text/plain","Server":"nginx"},"responseBody":"Service Unavailable","nextRetryAt":"2026-05-05T13:25:22Z","deliveryLogId":"98602c85-294d-4215-8e02-78c4458106d6","endpointId":"fa48084e-ed38-46e3-b761-774b76d06de1","endpointName":"Peppared Street Cafe's Reconciliation","endpointUrl":"https://example.com/webhooks/pepparedstreetcafe","eventId":"399f9d7d-0714-453c-9b6d-dda836e1d8e6","eventType":"settlement.batch.completed","attemptNumber":3,"deliveryLogStatus":"Failure","endpointHTTPResponseCode":503,"roundTripDurationMs":5012,"errorMessage":"Service Unavailable","createdOn":"2026-05-05T13:10:22Z"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/200/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/401/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/403/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/404/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/429/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}/get/responses/500/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/400/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/401/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/403/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/429/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1export/get/responses/500/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/200/content/application~1json/example":{"value":{"requestHeaders":{"Content-Type":"application/json","X-Flute-Signature":"t=1746450622,v1=5257a869e7ecebeda32affa6c66e8fb5e5e64a50b9b3e8bbf9c1a8d8f5e9d0a1","X-Flute-Event-Id":"0e991cfc-28cf-4558-8874-bf2bbee8a406","X-Flute-Event-Type":"settlement.batch.completed"},"requestBody":"{\"id\":\"8b7f1c87-c1da-48f7-82d1-426ae0960c53\",\"type\":\"settlement.batch.completed\",\"createdAt\":\"2026-05-05T13:10:00Z\",\"data\":{\"batchId\":\"617f9259-8900-4134-b035-c53dd5d9675e\",\"settledAmount\":12500.00}}","responseHeaders":{"Content-Type":"text/plain","Server":"nginx"},"responseBody":"Service Unavailable","nextRetryAt":"2026-05-05T13:25:22Z","deliveryLogId":"98602c85-294d-4215-8e02-78c4458106d6","endpointId":"fa48084e-ed38-46e3-b761-774b76d06de1","endpointName":"Peppared Street Cafe's Reconciliation","endpointUrl":"https://example.com/webhooks/pepparedstreetcafe","eventId":"399f9d7d-0714-453c-9b6d-dda836e1d8e6","eventType":"settlement.batch.completed","attemptNumber":3,"deliveryLogStatus":"Failure","endpointHTTPResponseCode":503,"roundTripDurationMs":5012,"errorMessage":"Service Unavailable","createdOn":"2026-05-05T13:10:22Z"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/200/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/400/content/application~1json/example":{"value":{"errors":{"Email":["'Email' is not a valid email address."]},"details":"One or more validation errors occurred.","statusCode":400,"source":"<Service>","exceptionType":"ValidationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/400/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/401/content/application~1json/example":{"value":{"errors":{"BearerTokenError":["invalid_token, error_description='The token expired at '06/29/2026 21:08:02''"]},"details":"One or more validation errors occurred.","statusCode":401,"source":"<Service>","exceptionType":"UnauthorizedException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"V0000","title":"Validation failed","cause":"One or more fields failed validation rules.","resolution":"Review the errors and correct the invalid fields.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/401/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/403/content/application~1json/example":{"value":{"details":"You do not have permission to access this resource.","statusCode":403,"source":"<Service>","exceptionType":"ForbiddenException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"F0000","title":"Access forbidden","cause":"You do not have permission to access this resource.","resolution":"Verify your credentials and permissions or contact your administrator.\"","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/403/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/404/content/application~1json/example":{"value":{"details":"Entity with ID b31fbe9f-eebb-45ce-9cae-92265389f47f does not exist or has been deleted.","statusCode":404,"source":"<Service>","exceptionType":"NotFoundException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":"b31fbe9f-eebb-45ce-9cae-92265389f47f","errorCode":"N0000","title":"Resource not found","cause":"The requested resource does not exist or has been deleted.","resolution":"Verify the resource ID is correct or retrieve a list of available resources.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/404/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/409/content/application~1json/example":{"value":{"details":"The request conflicts with the current state of the resource.","statusCode":409,"source":"<Service>","exceptionType":"ConflictException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"C0000","title":"Resource conflict","cause":"The request conflicts with the current state of the resource.","resolution":"Refresh the resource state and retry the operation, or use a different idempotency key.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/409/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/429/content/application~1json/example":{"value":{"details":"Too many requests sent in a short period.","statusCode":429,"source":"<Service>","exceptionType":"RateLimitExceededException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"R0000","title":"Rate limit exceeded","cause":"Too many requests sent in a short period.","resolution":"Wait before retrying the request. Check the Retry-After header for more information.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/429/content/application~1json/example"},"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/500/content/application~1json/example":{"value":{"details":"An unexpected error occurred while processing the request.","statusCode":500,"source":"<Service>","exceptionType":"IntegrationException","correlationId":"aa6cfcd0-0295-4a4c-b074-8c901f114fee","entityId":null,"errorCode":"I0000","title":"Internal server error","cause":"An unexpected error occurred while processing the request","resolution":"Please contact support with the correlation ID if the issue persists.","documentationUrl":"https://developer.flute.com/"},"id":"paths/~1v2~1webhooks~1delivery-logs~1{deliveryLogId}~1retry/post/responses/500/content/application~1json/example"}},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Specify the authorization token."}},"servers":[{"url":"/_mock/api-reference/v2","isMockServer":true,"description":"Mock server"},{"url":"https://sandbox.api.flute.com","description":"Sandbox environment"},{"url":"https://api.flute.com","description":"Production environment"}]},"options":{"hideDownloadButtons":false,"hideReplay":true,"schemasExpansionLevel":"all","jsonSamplesExpandLevel":"all","hideSchemaTitles":true,"expandResponses":"200","expandSingleSchemaField":true,"hideSidebar":true,"mockServer":{"url":"/_mock/api-reference/v2","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api-reference/@v2/index.json?download"},{"url":"/_bundle/api-reference/@v2/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Flute - API Reference Guide","description":"Build date: 8.13.2026 10:19 AM\n\n<div style=\"color: #d32f2f; border-left: 4px solid #d32f2f; padding-left: 1rem;\">\n<strong style=\"font-size: 1.5em;\">⚠️ Beta Release</strong>\n\nThe v2 API is currently in active development. \n\nFunctionality, request and response formats, field names, and behavior may change before the stable release. \nReview the release notes regularly for updates.\n\nContact [Developer Support](mailto:developer@flute.com?subject=About%20Flute%20API) for further details.\n</div>\n"}},"baseSlug":"/api-reference/v2","routesMapping":{}}